Хотелось бы узнать, есть ли какие-либо рекомендации по поводу конечной точки корня для веб-службы REST? Я имею в виду, должна ли это быть краткой документацией об использовании самого API? Должен ли он быть документом XML, описывающим все доступные методы? Должен ли он возвращать «неизвестный метод»?Каковы наилучшие практики для корневой страницы REST API?
Этот вопрос по заданию неясен. Я предполагаю, что это означает что-то вроде каталога, в котором все методы API находятся. Например, корневой каталог API Flickr будет http://api.flickr.com/services/rest/.
В качестве примера проект, который получает доступ к API Flickr см python-flickrapi
Я имею в виду на другой стороне ... вид на то, как файлы выглядят так, чтобы вызвать flickr api из веб-приложения ... – adam
Корневая точка REST API - это API, определенный для первого слэша i.e "/" URL-адреса после диспетчера-сервлета. Он содержит все GET для списка ресурсов (в основном, для всех таблиц базы данных), этот список содержит все элементы, а в одном элементе будут отображаться URL-адреса DELETE, PUT/PATCH и SELF. Таким образом, реализация HATEOS.
Вопрос совершенно ясен для меня.
Я думаю, что он должен ответить 404. Если ресурс не связан с корневым путем, то возвращаться нечего.
Если вы считаете, что 404 не полезно, тогда также было бы нормально вернуть URL-адрес документации.
Это плохо заданный вопрос! пожалуйста, предоставьте более подробную информацию. –