コントローラのRails REST APIドキュメントを自動生成する方法は？
Rails RESTコントローラーのAPIドキュメントを自動的に生成する方法は？
これを行うためにRDocを使用して調べることができる例はありますか？
あなたが試すことができます apipie-Rails私が作成したもの： https://github.com/Pajk/apipie-Rails/
ドキュメントを生成するだけでなく、 https://github.com/Pajk/apipie-Rails/ に関する詳細情報を生成することもできます。
https://github.com/zipmark/rspec_api_documentation は本当に素晴らしいツールであることがわかりました。これはrspec受け入れテストから駆動されるため、受け入れテストを作成すると同時にドキュメントを作成します。ダブルウィン！
rapi_doc gemを使用します。セットアップは非常にシンプルで簡単です。このチュートリアルに従ってください： http://www.rubyglob.com/generate-api-documentation-with-rapi_doc/
Railsに簡単に統合できる優れたドキュメントツールも探していました。最後に、独自のRailsエンジン [〜＃〜] apidoco [〜＃〜]
ただし、ドキュメントは自動生成されませんが、簡単に使用できます。
"calamum" a Rubyビルドプログラムを使用して、yamlファイル定義からNice html apiドキュメントを生成できます。 https://github.com/malachheb/calamum
自動ではありませんが、RESTful APIモデリング言語または [〜＃〜] raml [〜＃〜）を使用してAPIを定義および文書化します。 ] 。
raml2html のように、yamlファイルを見栄えの良いhtmlドキュメントに変換するNode.jsパッケージがあります。