Каков наилучший способ создания справочного документа API с использованием файла Rails rout.rb?

Question

Я пытаюсь документировать API для моего приложения на Rails, и я не могу не задаться вопросом, есть ли лучший способ генерировать файл XML на основе моего файла rout.rb.Я предполагаю что-то похожее на вывод rake routes, но в более дружественном формате XML.У Кори есть несколько интересных идей об использовании отражения / самоанализа в файле маршрутов здесь , но это не совсем то, что мне нужно.

Пожалуйста, скажите мне, что это решенная проблема, и я не первыйодин думать об этом.:)

Answer 1

rake routes - это обычная задача с граблями:

https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake

Возможно, вы могли бы извлечь из нее уроки и написать новое задание для генерации маршрутов в (-cough-)более дружественный формат XML.;)

Answer 2

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