Как вы документируете структуру XML REST API Call?

Question

Как и SOAP, который как WSDL, который позволяет генерировать код, который поможет создать запрос, существует ли какой-либо механизм в REST, который позволяет документировать полезную нагрузку или ответ на вызов API REST?

Большинство служб, которыепредоставьте REST API, похоже, предоставьте примеры для объяснения структуры.Какова лучшая практика для API REST.

Answer 1

Я считаю, что наилучшей практикой является предоставление образцов (или ссылок на образцы) для объяснения структуры. Разработчики, работающие против вашего API, не нуждаются в дополнительных инструментах или рабочих процессах, чтобы знать, как взаимодействовать с каждой частью вашего сервиса.

Answer 2

Если вы возвращаете xml, вы можете просто предоставить xsd.Существует также wadl, который некоторые фреймворки будут генерировать автоматически.