6

REST APIドキュメントを作成するためのマークアップを提供するライブラリはありますか?いくつかの企業が同様のドキュメントパターンを使用しているのを見てきました。例:

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

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

同じ図書館やサービスを利用しているのではないかと思います。基本的に、ライブラリは、マークアップテキストに基づいて、APIナビゲーション、検索、および表示用のページ(rubyドキュメントのYARDによく似ています)を生成する必要があります。

これは私がこれまでに見つけたものです:

4

3 に答える 3

7

あなたは間違いなくSwaggerを見ておくべきです。

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

于 2013-05-13T16:48:48.027 に答える
1

MasheryのIO/Docsをチェックしてください。

次世代のAPIドキュメントと探索であるMasheryI/ O Docsを使用すると、開発者はドキュメントから直接ライブAPI呼び出しを実行できます。ドキュメントがテストとデバッグをすべて1つの便利でインタラクティブなインターフェースで満たすと考えてください。

優れたドキュメントの別の例については、 ParseAPIドキュメントを確認してください。

また、FullContactAPIドキュメントの設計にも多くの時間を費やしました。ApigeeLiveAPIコンソールも利用しています。

于 2012-06-15T16:46:30.177 に答える
0

これは、APIドキュメント(Rails4およびRails5)に役立つgemです。

ApiDocohttps ://rubygems.org/gems/apidoco/versions/1.2.0

セットアップは非常に簡単で、優れたユーザーエクスペリエンスを提供します。

于 2017-04-12T05:16:42.160 に答える