您如何使用 rdoc 记录 padrino 路由方法？答案

【问题标题】：how do you document padrino route methods using rdoc?您如何使用 rdoc 记录 padrino 路由方法？
【发布时间】：2013-07-04 12:02:52
【问题描述】：

我想使用 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 或标记在单独的文件中记录 API 调用，但这似乎是 20 世纪。

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

【问题讨论】：

标签： web-services padrino rdoc

【解决方案1】：

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

【讨论】：

只是作为对未来搜索者的帮助，这是行不通的。