簡単なAPIドキュメントを生成するルビーの宝石とは何ですか？

Question

ですがすることができる任意の単純ルビ宝石：

1. 動的にルーティングおよびAPIのコントローラのアクション上記のコメントに基づいて、APIドキュメントを生成します。新しいデベロッパーのためにコード内のドキュメンテーションがほしいと思うので、APIドキュメントのためだけに別々のビューを維持する必要はありません。

2. APIドキュメントウェブサイトをアプリ内の別のルートの下に表示します。私は、APIドキュメントを公開するために別途api-documentation-serverを実行する必要はありません。

3. カスタムコメントを表示します。 APIエンドポイントの詳細な説明を書きたい場合だから、APIエンドポイントとリクエスト/レスポンスだけを示すドキュメントは必要ありません。

4. JSONでリクエストと応答の例を指定します。さまざまな失敗条件に対する複数の応答の例を指定することを含みます。

5. （ボーナス）ドキュメントのコメントにマークダウンを解釈します。

6. （ボーナス）Ruby、Swiftなどのさまざまな言語で各APIエンドポイントをリクエストするためのコードを生成して表示します。

7. （ボーナス）API docsウェブサイトを通じてAPIに対して実際のリクエストを実行します。

PS：これはREST API向けですが、実際には違いがある場合はカスタムルートがあります。私はRailsを使っています。

Answer 1

私はいつもSwagger

Answer 2

私はあなたが質問のタグからRailsを使用していると仮定しています。

このApipieを使用して、RAILSバックエンドサービスのドキュメントを作成しました。あなたの最初の4つのポイントはこれで十分カバーされています。マークアップ言語もサポートしていると主張しています。私はそれを試していない。