Как автоматически генерировать Rails API REST для контроллеров?

Как автоматически генерировать документацию API для Rails-контроллера Rails?

Есть ли какой-нибудь пример, который я могу изучить в использовании RDoc для этого?

Ответы

Ответ 1

Вы можете попробовать apipie-rails, который я создал: https://github.com/Pajk/apipie-rails/

Он может делать больше, чем просто генерировать документацию, больше информации о https://github.com/Pajk/apipie-rails/.

Ответ 2

Я нашел https://github.com/zipmark/rspec_api_documentation, чтобы быть действительно хорошим инструментом. Он отключил приемные тесты rspec, поэтому вы пишете документацию одновременно с написанием приемочных тестов! Двойная победа!

Ответ 3

Используйте rapi_doc gem. Настройка очень проста и прямолинейна. Следуйте этому руководству: http://www.rubyglob.com/generating-api-documentation-with-rapi_doc/

Ответ 4

Вы можете использовать программу "calamum" для создания Ruby, чтобы генерировать хороший html api doc из определения файла yaml. https://github.com/malachheb/calamum

Ответ 5

Хотя это не автоматическое, я определяю и документирую свои API-интерфейсы с использованием языка моделирования API RESTful или RAML.

Есть пакеты Node.js, которые превращают yaml файл в красивую документацию html, например raml2html.

Ответ 6

Я также искал хороший инструмент для документации, который можно легко интегрировать в рельсы. Наконец, мы построили собственный рельсовый двигатель APIDOCO

Однако он не автоматически создает документацию, но вы можете легко ее использовать.