問題タブ [api-doc]

apidocREST API ドキュメントの生成に使用し始めました。私はそれでさまざまなことを試しました。

私のflaskベースのAPIアプリケーションではJWT、認証に（特にflask-jwt）を使用しています。ドキュメントは正しく生成されますが、ドキュメントからのリクエストは正しく行われません。

これはdocsting、ドキュメントを生成するために配置した場所です

ドキュメントを生成すると、適切に生成されます

1. しかし、生成されたドキュメントから認証情報を渡すと、リクエストは失敗します。フラスコのリクエストで取得したリクエストデータは''（空）です
2. Content-Typedocstring にヘッダーを含めた後でも失敗します。フラスコのリクエストで取得するリクエストデータはusername=test@example.com&password=test123

Flask-JWTのコードにデバッグポイントを入れることで上記を確認しました

しかし、それを使用して同じリクエストを行うと、postman適切に行われます。

郵便配達員のヘッダー

APIDoc ヘッダー

私は何を取りこぼしたか？

API ドキュメントを生成すると、現在、インデックス ページの左側にある個々の API へのリンクが API の説明から生成されています。

リンク名は、メソッド タイプ (上記の例ではpost ) と@apiNameの組み合わせにしたいと考えています。このブロック コメントの場合:

この API のリンク テキストをPOST - Create Cakeにしたい

とにかくこれを行うことはありますか？

apidocjsを使用して、asp.net Web API アプリのドキュメントをセットアップしました。Visual Studio で Web API を実行すると、自分のマシンではすべて正常に動作しますが、アプリをデプロイしたサーバーでは動作しません。apidocjs によって生成された index.html に移動すると、404 エラーが発生します。IISの問題だと思います。

これを解決する方法について提案が必要ですか?

ROR Api Dock は常にメソッドの構文から始まります。私の例は link_to になります:

link_to(name = nil, options = nil, html_options = nil, &block) public

私の質問は、ほとんどすべてのコマンドで見られる"name=nil"orです。"something = nil"

2 番目の例: url_for(options = nil)

誰かがこれのポイントまたはそれが言おうとしていることを説明できますか..オプションがオプションであることを意味しますか?

どうしてそれが重要ですか..

だから私はLumenで作成されたAPIを持っており、パブリックフォルダーの外でApidoc でいくつかのドキュメントが作成されており、ユーザーがURLにアクセスしたときにそれを提供したいと思いますhttp://apidomain.com/docs

これがアプリの構造です

ユーザーを API/Docs に送るルートを作成する方法はありますか?

Django REST Swagger によって生成された Swagger ドキュメントを変更したいと考えています。Django REST Swagger が生成する API 定義またはスキーマ ファイルを見つけたいです。それらのファイルを見つけることができませんでした。

Django REST Swagger が API ドキュメントを作成するときに生成される YAML または JSON ファイルのようなものはありますか?

サーバー上のどこでそのファイルを見つけることができますか?

ありがとう！