REST APIドキュメントの生成

Question

REST APIのドキュメントを書くためのマークアップを提供するライブラリはありますか？私は例えば、いくつかの企業が同様の文書パターンを使用して見ている：彼らは同じライブラリまたはサービスを使用している場合、私は疑問に思って

http://api.teamlab.com/2.0/

http://www.fullcontact.com/docs/?category=person

。基本的に、ライブラリは、マークアップテキストに基づいて、APIナビゲーション、検索、および表示用のページを生成する必要があります（Rubyドキュメントの場合はYARDとよく似ています）。

• rapi_doc gemを：

  これは私がこれまでに発見したものです。使用法についてはarticleです。

Answer 1

あなたは間違いなくSwaggerを見てください。

これはオープンソースで、何百ものAPIで使用されており、API管理ソリューションでは3scaleによってActive Docsという名前で使用されています。

Answer 2

MasheryからIO/Docsを確認してください。

次世代のAPIドキュメントと開発ツールである開発者は、開発者がドキュメントから直接ライブAPI呼び出しを実行できるようになります。シンプルなインタラクティブなインターフェースで、テストとデバッグを行うことができます。

偉大なドキュメントの別の例については、Parse API Docsをご覧ください。

また、FullContact API Docsのデザインに多くの時間を費やしました。我々はApigee Live API Consoleも利用しています。

Answer 3

これは、API documentaion（Rails4とRails5）

ApiDoco https://rubygems.org/gems/apidoco/versions/1.2.0ために有用宝石です。

設定が非常に簡単で、ユーザーエクスペリエンスが優れています。