2013-03-22 22 views
1

我想使用RDoc在Padrino中編寫的Web服務應用程序中記錄API調用。下面是一個示例文件:如何使用rdoc記錄padrino路由方法?

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調用,但似乎是二十世紀。

其他人怎麼處理?

回答

0

既然Padrino是基於Sinatra,記錄路線是可行的這個寶石yard-sinatra

+0

正如對未來的搜索者的援助,這不起作用。 – peregrine 2014-10-18 18:43:52

相關問題