1

我想使用 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 世纪。

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

4

1 回答 1

0

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

于 2013-04-10T12:14:22.540 回答