你如何使用rdoc记录padrino路由方法?

时间:2013-03-22 00:13:18

标签: web-services padrino rdoc

我想使用RDoc来记录用Padrino编写的Web服务应用程序中的API调用。这是一个示例文件:

Analytics.controller :api do
  diable :layout

  ##
  # = <base_url>/ping - test for response
  # The +ping+ command is a quick way to verify a live connection to the
  # service.
  get :ping, :provides => :json do
    {:time => timestamp(), :version => version_string()}.to_json
  end

end

但由于没有周围的类,rdoc不会为:ping方法创建文档。当然,我可以使用rdoc或markup在单独的文件中记录API调用,但这似乎是二十世纪。

其他人如何处理这个问题?

1 个答案:

答案 0 :(得分:0)

由于Padrino基于Sinatra,因此使用此gem yard-sinatra可以记录路线。