стиль дизайна RESTful API

Общие HTTP глаголы

  • GET (ВЫБРАТЬ): Удалить ресурс с сервера (один или более).
  • POST (CREATE): новый ресурс на сервере.
  • PUT (UPDATE): обновить ресурс (после полных ресурсов, предоставленных клиентом для изменения) на сервере.
  • PATCH (ДОПОЛНЕНО): Обновление ресурса (предоставленный клиентом, чтобы изменить свойство) в сервере.
  • УДАЛИТЬ (DELETE): Удалить ресурс с сервера

RESTful спецификации проектирования архитектуры:

URL лучше не появляться глагол, чтобы использовать множественное число существительного

URL-адрес может быть номер версии, номер версии может быть выполнен в заголовке запроса, но не как непосредственно в URL

Фильтрация параметры могут быть размещены в строке запроса

Для различных операций, сервер возвращает данные ответа

Для того, чтобы использовать ответ формат данных JSON

Ответ код состояния: 1 ** (получено, необходимо продолжать лечение), 2 ** (запрос успешно), 3 * (запросы переадресации), 4 * (ошибка запроса), 5 ** (ошибка сервера)

API должен попытаться быть развернут в доменном имени частного, если API очень прост, и не имеет дальнейшее расширение на основном доменное имя может быть рассмотрена в рамках

RESTful API лучше делать HyperMedia (т.е. возвращаемые результаты дают ссылки на другие методы API), так что пользователь не проверяет документы, но и знать, что делать дальше.

рекомендация

отwww.cnblogs.com/Gdavid/p/11925000.html