闊歩を置くためにいくつかの時間をポンピング週末はここに要約についての書き込み記事に、見ました。SWAGGERの公式ウェブサイトは、オンラインデモ、オンライン経験を持っています。また、ダウンロードすることができ、ソースコードを、DIST \ index.htmlのファイルを実行すると、あなたは同じ機能のデモを得ることができます公式サイトでは、使用することができますサーバーを設定する必要はありません。
ネットワーク要求から見ると、それはのswagger.jsonという名前のファイルを要求したことがわかりました。
基本的なスキームは、JSONファイルを定義した文書です。このページから、我々は基本的に闊歩の原則を見つけることができます。
-
闊歩インターフェイススキームを定義するJSON文書ベースOpenAPIの仕様を、依存しています。
-
ページが読み込まれた後、スキームが指定されたインターフェイスを取得した後、インタフェース・ページを生成します。
-
実行]をクリックし、AJAXリクエストを送信し、その後、結果がブラウザインタフェースのテストを通じて達成するためには、画面に表示されます。
簡単に言え、闊歩インタフェースのテストは、純粋なフロントエンドを達成することである、バックエンドのサポートは必要ありません。これは、輸入スキームによって、また同じ機能を実現することができ、実際には、郵便配達もOpenAPIの仕様をサポートし、郵便配達のオンライン版です。しかし、郵便配達と比べて、闊歩は、次のような利点があります。
-
ローカルクライアントありません
-
そして、アプリケーションの統合は、手動でインターフェイス定義をインポートする必要はありません
-
ユーザーは、多くの場合、自動的にアイデンティティの基礎となり得るブラウザから送信さAJAX要求、非常に使いやすいインタフェースを備えたアクセス制御テスト。
.NETコアでは、swaggeruiおよびサイトの統合には、次の手順が必要になります。
-
よるApiExploreインターフェイスのドキュメント生成されたコンテンツ
-
登録ルーティング、インターフェイスのドキュメントのダウンロードを提供
-
あなたのサイトに統合さswaggeruiページ
-
ルーティングパスが闊歩ページに設定されています
二段階の簡単な用語は、インターフェースドキュメントのダウンロードURLと統合swaggeruiを提供しています。：現在の.NET core'veは、次のような、いくつかのオープンソース実装を持っswashbuckleとnswag。ほとんどのシナリオでは、それらを直接使用することは非常に便利です。
しかし、時には我々は、このような集中型のAPIページを提供するために必要な、分散サービスなどの一部の高度な機能を必要とする、またはページがいくつか（例えば、グループ化など、アクセス制御、スタイル調整）のカスタマイズを必要とします。これらのライブラリはまた、柔軟な十分ないくつかのサポートを提供しますが、多くの場合ではないが。簡単な解決策は以下のとおりですのみ闊歩インタフェースドキュメントswagger.jsonに基づいて、公式の静的なページで独自のカスタムUIを生成するためにこれらのライブラリを使用して、より柔軟に、これを。