Пример хорошо зарекомендовавшей себя службы RESTful

Ответ 1

Пожалуйста, ознакомьтесь с документацией REST API Documentives Best Practices для документирования вашего сервиса RESTful. Документ охватывает все аспекты. Вот его фрагмент.

Заголовок: Показать всех пользователей. URL:/пользователи или/пользователи/: id или /users? id =: id
Метод: GET | ПОСТ | УДАЛИТЬ | PUT
Параметр URL: Required: id = [целое число] ИЛИ Optional: photo_id = [alphanumeric]
Параметры данных: {u: {email: [string], name: [string], current_password: [alphanumeric] password: [alphanumeric], password_confirmation: [alphanumeric]}}
Коды ответов: Успех (200 OK), Неверный запрос (400), Несанкционированный (401)

Ответ 2

Вы слышали о http://swagger.io/? Он создает очень полезную (и приятную) документацию для REST API.

Попробуй. Я действительно рекомендую это.

Ответ 3

Вы можете ссылаться на Zoho Subscriptions API. Этот документ с тремя столбцами структурирован по ресурсам и имеет образец запроса и ответа для каждой конечной точки.

Раскрытие информации: Я являюсь частью группы подписчиков Zoho.

Ответ 4

Twitter Api documentation - лучшее, что я встретил.

Ответ 5

API CouchDB," база данных RESTful.

Вы заметите, что документ структурирован ресурсом, а не методом, что делает его более ресурсо-ориентированным, чем большинство известных документов API.

Ответ 6

Попробуйте rest-tool.

Это соответствует языковому агностическому подходу к написанию спецификации. Обеспечивает мгновенную реализацию макета и автоматическое модульное тестирование для API RESTful с полки.

Услуги указываются через файлы YAML, и образцы данных могут быть размещены рядом с дескрипторами. Вы можете найти схему JSON aboult в формате файла дескриптора service.yml. Это можно использовать как гильдию, но она может быть расширена по требованию.

Ответ 7

API удобочитаемости недавно был отмечен в Twitter.

Раскрытие информации: я являюсь партером в Arc90, создателями Readability и инвестором в Readability.