Я разрабатываю приложение Ruby on Rails, которое предоставляет API, совместимый со спецификацией JSON-API . Следуя спецификации JSON-API, мои конечные точки работают одинаково для таких задач, как сортировка, фильтрация, получение определенной записи и т. Д.
У меня сложилось впечатление, что усилия по документированию должны фокусироваться больше на документировании моих моделей и их атрибутов, чем на каждой конечной точке в отдельности. Таким образом, традиционные инструменты, такие как APIPIE , по-видимому, требуют ненужных усилий для ведения документации.
Существует ли какой-либо инструмент или подход, облегчающий создание документов для API, соответствующих спецификации JSON-API?