問題タブ [api-doc]

API を文書化する必要があります。SlateまたはSwaggerのいずれかを使用する必要があります。どちらがより多くのオプション、長所と短所を持っているか、どちらが優れているかを知りたいです。

Swashbuckle 5.1.3 の最新バージョンを使用してSwaggerResponseいますが、応答コードごとに応答タイプを文書化できる新しい属性があることに気付きました。例えば：

( https://github.com/domaindrivendev/Swashbuckle/issues/175 < 役立つかもしれません)。

最初の応答クラスは問題なく文書化されていますが、それが の表を示している場所のさらに下では"Response Messages"、応答モデルは空です (400 Bad Request の場合)。他の応答タイプが文書化されている画面のどこにも表示されません。

動的フォーム (services(!) として定義) を使用して、特定のリクエスト (POST/PUT/PATCH) に対していくつかのフィールドを有効/無効にします。documentation で説明されているように、フォームにオプションを渡すことで、ApiDoc に自動的に表示されるようにします。しかし、うまくいきません。私はこれを使用します：

しかし、xdebug を使用すると、"options" = {​​"method" = "PUT"} を指定しない場合のように、$options['method'] が常に 'POST' と等しいことがわかります。

gemを使用していgrape-swaggerますが、Swagger で適切に記述された Grape ベースの API を取得できません。使用:grape (0.11.0)およびgrape-swagger (0.10.1)

Swagger json リストを有効にすると、すべてのエンドポイントがリストされたこの出力が得られますが、各エンドポイントに含まれるメソッドはリストされません。

私の出力：

次のように config.ru に CORS Allowance も追加しました。

内部にリストされている各エンドポイントのメソッドを取得する方法の手がかりはありますか?

ドキュメントの生成に Swagger 2.0 を使用しています。私のコントローラークラスには、次のような操作があります。

上記の操作の応答用に生成された Swagger ドキュメント:

ここで、Swagger のドキュメントには、応答が であるとは記載されていませんPage<Employee>。Swagger のドキュメントでジェネリック データを取得するにはどうすればよいですか?

次の戻り値の型がある場合はどうなりますか?

Swagger 操作パラメーターとモデル プロパティについても同様です。

現在、ドキュメントが 3 つの場所に分散している Python プロジェクトがあります。Python ファイルの例、Sphinx ドキュメント (IPython ノートブックから生成されたものもあります)、IPython ノートブックがあります。このすべてのドキュメントを IPython ノートブックの 1 つのセットに統合することを検討しています。最終的には、すべてのドキュメントを 1 か所に移動し、1 つのツール (IPython ノートブック) を使用することで、ユーザーと開発者の両方の生活を楽にしたいと考えています。正直なところ、ドキュメントの保守に必要な時間を最小限に抑えることは、ここでは最優先事項です。すべての開発者は、空き時間に無料で作業しています。

IPython ノートブックに対する Sphinx の大きな利点の 1 つは、Sphinx が apidoc を使用してコードから API ドキュメントを自動的に生成できることです。ライブラリの python ファイルを走査し、ノートブックに表示する docstring を抽出するコードを書くことで、IPython ノートブックでこの動作を再現できるはずです (数学や画像、および docstring の関連セクションのレンダリングを含む)。 (パラメータ、戻り値、注意事項など))。私の質問は次のとおりです。そのようなツールは既に存在しますか? つまり、Python ディレクトリを歩き回り、docstring を抽出して IPython ノートブックに表示できるツールで、理想的にはきれいな HTML フォーマットを使用していますか?

apidocを使用して、API ドキュメントを Github のフラット テキスト ファイルから Javadoc コメントに移動しています。

そのため、Javadoc 構文で記述したい API 出力の例が既にあります。*たくさんあるので、手動で入力せずに各行の先頭に少し追加する必要があります。Eclipseでそれを行うことは可能ですか? どこにも見つかりません。

例 ：

回したい

の中へ

Sails.js と Node.js は初めてで、アプリケーションのドキュメントの作成に問題があります。

私の手順は次のとおりです。

• インストールされた apidoc: npm install apidoc -g
• インストールされた grunt モジュール: npm install grunt-apidoc --save-dev
• 一番下grunt.loadNpmTasks('grunt-apidoc');に追加Gruntfile.js
• ファイルを作成grunt.initConfigし、次を置きます：

apidoc: { myapp: { src: "api/controllers/", dest: "apidoc/" } }

次に、複数のことを実行しようとしていますが、どれもAPIドキュメントを生成しません:

• セイルリフト
• うなり声
• うなり声のデフォルト
• ノード app.js

手動で実行すると、apidoc -i api/controllers/ -o apidoc/正常に動作しています。

私は何を間違っていますか？どうやってするの？