Каковы лучшие практики для корневой страницы отдыха API?
https://stackoverflow.com/questions/2894723
-
04-10-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianВопрос
Я хотел бы знать, есть ли несколько лучших практик о конечной точке root для веб-службы отдыха? Я имею в виду, если это будет краткое документацию о использовании самого API? Должен ли это быть документом XML, описывающий все доступные методы? Должен ли он только вернуть "неизвестный метод"?
Решение
Этот вопрос, как задают неясно. Я думаю, что это означает что-то вроде каталога, что все методы API находятся под. Например, корневой каталог API Flickr будет http://api.flickr.com/services/rest/.
Для примера проекта, который обращается к API Flickr, см. Python-Flickrapi
Другие советы
Вопрос совсем понятен для меня.
Я думаю, что он должен ответить 404. Если нет ресурса, связанного с корневым путем, то нечего возвращать.
Если вы чувствуете, что 404 не полезно, то было бы нормально, чтобы вернуть URL документации.
1. Nerddinner использует услуги по данным WCF, что является отличным способом правильности реализации спокойных услуг. Причина, по которой я указываю на это, и не поддерживает службы данных WCF напрямую, потому что это публичный веб-сайт, и вы можете использовать его. 2. MediaWiki - не отличный пример, потому что они передают действия на УРИ, но это технически спокойная служба и шоу много интересных идей.
Точка REST API REANDEND - это API, определяемый для первой косчики, т. Е. / "URL после диспетчера-сервлета. Он содержит все получение для списка ресурсов (в основном получение всех таблиц базы данных) Этот список дополнительно содержит все элементы, а в одном элементе будет удалить, PUT / PATCH и SEA получить URL. Таким образом, делая реализацию Hateos.
Предполагается, что отдых о том, чтобы быть свидетельственным, поэтому у корневого шоу ошибка плохой дизайн на мой взгляд. Мне нравится root, чтобы содержать информацию, которая позволяет навигаться по остальной части API. Таким образом, корню может содержать ссылку на список категорий продуктов, из которых пользователь API может выбрать категорию, а затем список продуктов и т. Д. Я, описывающую API, означает меньшую документацию для записи и обновления !!
