Я нашел https://github.com/zipmark/rspec_api_documentation, чтобы быть действительно хорошим инструментом. Он отключил приемные тесты rspec, поэтому вы пишете документацию одновременно с написанием приемочных тестов! Двойная победа!
Вы можете использовать программу "calamum" для создания Ruby, чтобы генерировать хороший html api doc из определения файла yaml.
https://github.com/malachheb/calamum
Ответ 5
Хотя это не автоматическое, я определяю и документирую свои API-интерфейсы с использованием языка моделирования API RESTful или RAML.
Есть пакеты Node.js, которые превращают yaml файл в красивую документацию html, например raml2html.
Ответ 6
Я также искал хороший инструмент для документации, который можно легко интегрировать в рельсы. Наконец, мы построили собственный рельсовый двигатель APIDOCO
Однако он не автоматически создает документацию, но вы можете легко ее использовать.