Что я должен использовать для документирования моих маршрутов Синатры?

Question

Я ищу что-то вроде RDoc, которое будет хорошо работать с Синатрой.В дополнение к обычным маршрутам Синатры, он должен иметь возможность обрабатывать маршруты, которые загружаются извне через 'register MyModule' и в форме:

Module MyModule
  def self.registered(app)
    # Description of someroute.
    app.get '/someroute' do

Answer 1

Перейти с ярд . с домашней страницы двора:

Вы можете написать все виды расширений в YARD, в том числе те, которые могут понять все динамическое волшебство, которое ваша инфраструктура делает на своих собственных маленьких Doman Specific Languages ​​(DSL). Самое главное, это действительно легко сделать! Уже есть плагины, которые поддерживают такие фреймворки, как RSpec, DataMapper, Sinatra и поддержка других.

Кажется, здесь есть плагин: https://github.com/rkh/yard-sinatra, который делает, по крайней мере, то, что вы уже хотели.

Удачи!

Answer 2

Я просто хотел отметить, что Yard поддерживает маршруты Sinatra изначально, начиная с версии 0.7.0, поэтому вам больше не нужна ярд-синатра.

Вы можете найти больше информации на https://github.com/lsegal/yard/wiki/SinatraRoutes