Структурирование онлайн-документации для REST API

Я создаю свой первый Rest API, который сериализует данные в форматы JSON и XML. Я хотел бы предоставить клиентам API страницу индекса, где они могли бы выбирать реализованные конечные точки.

Какую информацию мне нужно включить, чтобы сделать мой API наиболее полезным, и как мне ее организовать?

85
задан Ben Voigt 21 January 2017 в 02:40
поделиться