Каковы лучшие практики для корневой страницы API REST?

Я хотел бы знать, существуют ли некоторые лучшие практики о корневой конечной точке для веб-сервиса REST? Я имею в виду, это должна быть короткая документация об использовании самого API? Это должен быть XML-документ, описывающий все доступные методы? Это должно только возвратить "неизвестный метод"?

15
задан adam 28 June 2016 в 06:53
поделиться

2 ответа

Этот вопрос неясен. Я предполагаю, что это означает что-то вроде каталога, в котором находятся все методы API. Например, корневой каталог Flickr API будет http://api.flickr.com/services/rest/ .

Для примера проекта, который обращается к Flickr API, см. python-flickrapi

2
ответ дан 1 December 2019 в 04:17
поделиться


1. NerdDinner использует службы данных WCF, что является отличным способом правильно реализовать службы RESTful. Причина, по которой я указываю на это, а не на службы данных WCF напрямую, заключается в том, что это общедоступный веб-сайт, и вы можете его использовать. 2. MediaWiki - не лучший пример, потому что они передают действия в URI, но технически это служба RESTful и демонстрирует множество интересных идей.
2
ответ дан 1 December 2019 в 04:17
поделиться
Другие вопросы по тегам:

Похожие вопросы: