問題タブ [swashbuckle]

swagger/swashbuckle を使用して Web Api 2 に実装された API のドキュメントを生成しています。

認識される唯一の xml ドキュメント タグは<summary>、<remarks>と<param>です。
これは<para>、タグを使用してテキストを新しい行または段落にフォーマットすることができないことを意味します。ドキュメントの実装ノート エントリでは、すべてが連続した長い段落として生成されます。

これを行う方法はありますか？

Swashbuckle で構成された ASP.NET WebApi を使用して、swagger ui を表示しています。IIS Express の VS 内から実行します。解決策はVS 2013にあり、うまくいきました。VS 2015 への移行後、swagger にはメソッドが表示されません。エラーはありません。空のリストです。返される応答は次のとおりです。

ドキュメントのトラブルシューティングの章を確認しましたが、それに基づいて構成は問題ありません。次に何を試すことができますか？

API の IHttpActionResult を返すために、Asp.Net で Swashbuckle.Core を使用しています。問題は、Swagger の応答が応答コード 0 を返し、応答本文にコンテンツがないことですが、郵便配達員を介して同じ呼び出しを行うと、リダイレクト先の画像が返され、応答コードが 200 になります (これは私が行った動作です)。欲しいです）。

swagger はこのようなリダイレクトを許可しますか? 不足している設定や、これを修正する方法に関するその他の提案はありますか?

私が返す IHttpActionResult:

編集：

これは既知の Swagger の問題のようです https://github.com/swagger-api/swagger-ui/issues/549

私は最近、エンジニアに API 機能を内部的に公開する目的で、swashbuckle を使用して Web API に swagger を統合することを提案しました。私たちの目的では、API がバックエンドであるため、swagger は本番環境では意味がありません。エンタープライズ環境であるため、API の量が多く、次の 2 つの大きな問題が予測できます。

アセンブリのサイズは約 2.6MB です。 swahbuckle が統合された数百の API ビルドが突然、すべてのアプリのサイズが 4.5 倍に増加したと仮定します。理不尽な一撃。swashbuckle.core を見ると、サイズの大部分はバンドルされている swagger-ui によるものだと思われます。swashbuckle から swagger-ui をアンバンドルし、代わりに別の nuget パッケージを介して swagger-ui を追加できるようにすることは可能でしょうか。

swashbuckle 内にバンドルされた swagger-ui には、swagger-ui の独自のインスタンスを持つすべての API があります。swagger-ui に加えられたカスタマイズは、すべての単一の api プロジェクトに変更を加えない限り、他のプロジェクトには影響しません。これにより、労力が増加し、保守性の可能性が減少します。私たちはswagger-uiを一元的にホストしており、開発者がswagger実装をローカル（ローカルホスト）で試すことができるようにカスタマイズを行っているため、swagger-uiを統合するswashbuckleの影響を大きく受けており、swagger-uiをプルするオプションがあった方がはるかに優れていたでしょう.オプションで別の nuget パッケージ。

上記の問題に対処するためのパイプラインはありますか?それとも、維持する必要があるという犠牲を払って、単純にフォークして先に進むための最良の機会はありますか?

私は Microsoft スタックに精通しています。一部の安らかなサービスに OData を使用しています。最近、API ドキュメントの Swagger に出会い、OData との関係を理解し​​ようとしています。どちらもRESTful仕様のようです。広く使われているのはどれ？

私は多くの情報源に従って、JWT 認証を WebApi2 プロジェクトに実装しようとしてきました。また、swagger.ioとSwashbuckleを使用して、API の文書化とテストの両方を開始しました。私は、例外なしがメソッドをサポートして/auth/loginを生成し、api_keyそれを使用して承認を必要とする他のメソッドを呼び出す方法に触発されました。

また、私の開発は、パッケージを使用したトークンベースのセキュリティを紹介するASP.NET Web API 2JwtAuthForWebAPIブックに基づいているため、次のように JWT Delegating Handler を実装しています。

(私は web.config 資格情報を設定しており、コードは正常に実行されます)

問題は：

1. 例外なしとは異なり、入力後にメソッドを呼び出すとapi_key、swagger はキーを「ベアラー」承認ヘッダーではなくクエリ文字列に配置します
2. 上記のコードが JWT のクエリ文字列をチェックしているかどうかはわかりません (チェックしていたとしても、多くの理由 (セキュリティ、長い URL) からそれほど賢明ではないように思えます)。
3. 上記のコードは Delegating Handler をビルドするため、デバッグして実際に何をしているのかを確認することはできません ( log4netをリンクできますか?)
4. [Authorise]その結果、失敗したため、コントローラーメソッドはヒットしません。

この時点での私の質問は、上記の項目 1 を解決して、2 を問題にせず、(うまくいけば) 4 を機能させることだと思います! ありがとう。