1

Padrino で作成された Web サービス アプリで API 呼び出しを文書化するために RDoc を使用したいと考えています。ファイルの例を次に示します。

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 に答える