Существует ли документация REST API, в которой публикуется только корневой URL-адрес?

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

Но я не могу найти никакой документации API, которая действительно делает это. Каждая документация по REST API, которую я когда-либо читал в Интернете, содержит точное описание URL-адресов возможных конечных точек.

Существует ли какая-либо документация по API, в которой показан только корневой URL-адрес и описано, как перемещаться по ресурсам?


api rest hyperlink
person Franz Deschler    schedule 30.06.2020    source источник
comment
Мы делаем это, но это не публично. Однако для большинства людей, когда они ссылаются на REST, они, как правило, имеют в виду CRUD, JSON, а не поиск ресурсов, гипермедиа.   -  person Evert    schedule 30.06.2020

Ответы (1)


arrow_upward
1
arrow_downward

Одна из наиболее важных тем, связанных с REST, заключается в том, что ресурсы должны быть связаны через ссылки, а клиент должен знать только корневой URL-адрес API.

Корневой URL и типы мультимедиа — да. Клиент должен знать, с чего начать, а также как интерпретировать полученные ответы.

Вашим основным примером REST API будет всемирная паутина. Вы указываете в своем браузере www.google.com, а затем просто переходите по ссылкам и отправляете формы, пока не получите желаемый результат.

Другой REST API, который может быть вам знаком, — это Atom Syndication / Atom Pub.

Более академически, есть RESTBucks. Этот документ был несколько популярен, и вы можете найти множество примеров его реализации.

Джон Мур (2011) представил хорошую демонстрацию API гипермедиа.

Каждая документация по REST API, которую я когда-либо читал в Интернете, содержит точное описание URL-адресов возможных конечных точек.

Да; плохие примеры встречаются намного чаще, чем хорошие.

person VoiceOfUnreason    schedule 01.07.2020
comment
Точно. Я ищу хороший пример. Даже не код и структура объекта. Я просто ищу пример документации, ведущей пользователя через ресурсы API. - person Franz Deschler; 01.07.2020