Swagger サービスの公開ウィザード

Swagger ドキュメントに基づいてサービスを公開します。このウィザードでは、Swagger ドキュメント、ルーティング URI、API ホストとパスを指定する手順が示されます。必要に応じて、サービス ポリシーで要求メッセージに適用する検証オプションを選択できます。ウィザードでは、最初に役立つサンプル テンプレート ポリシーが作成されます(「」を参照)。
gateway91
Swagger ドキュメントに基づいてサービスを公開します。このウィザードでは、Swagger ドキュメント、ルーティング URI、API ホストとパスを指定する手順が示されます。必要に応じて、サービス ポリシーで要求メッセージに適用する検証オプションを選択できます。ウィザードでは、最初に役立つサンプル テンプレート ポリシーが作成されます(「Validate Against Swagger Document アサーション」を参照)。
このウィザードにアクセスする方法: [Tasks]-[Services and APIs]-[Publish Swagger Service Wizard]
使用しているサービスに対する受信プロトコルが、Swagger サービスのプロトコルと異なる場合は、(このウィザードで生成されるテンプレート ポリシーで) Route via HTTP(S) アサーションを変更して、そのプロトコルを使用するようにしてください。たとえば、受信 SSL を Swagger ポリシーに追加したが、Swagger バック エンドで HTTP を使用する場合があります。この場合は、テンプレート ポリシーで Route via HTTP(S) アサーションの URL の先頭を 「
${request.url.protocol}:
」から「
http:
」に変更します。
クラスタ プロパティ
このウィザードでは、
swagger.maxDownloadSize
クラスタ プロパティを観測して、Swagger ドキュメント ダウンロードのサイズを制限します。詳細については、「その他のクラスタ プロパティ」を参照してください。 
Security
このタスクでは、「管理者」ロールが必要です。 
ウィザード
手順
説明
1
Swagger ドキュメントの場所を指定します。このドキュメントは、HTTP/HTTPS サーバでホストされ、オンラインである必要があります。
URL のオプションを設定する(たとえば、認証情報、SSL、またはプロキシ オプションを指定する)には、
[HTTP Options]
をクリックして[Manage HTTP Options]ダイアログ ボックスを開きます。
Swagger ドキュメントの場所を解析できないというエラー メッセージが発生した場合、認証が必要である可能性があります。この場合、
[HTTP Options]
をクリックして URL のオプションを設定します。
2
  • Service Name
    : サービスの名前を入力します。タイトルが Swagger ドキュメントで設定されている場合は、デフォルト値として設定されます。
  • Routing URI
    : 公開するサービスの解決 URI を入力します。ベース パスが Swagger ドキュメントで設定されている場合は、デフォルト値として設定されます。
  • API Host
    : ホスト名または IP アドレスを入力し、必要に応じてポートを含めます。例:
    foobar.swagger.io:8080
    。API ホストが Swagger ドキュメントで設定されている場合は、デフォルト値として設定されます。
  • API Base Path
    : 有効なパスを入力し、先頭に '/' 文字を付けます。ベース パスが Swagger ドキュメントで設定されている場合は、デフォルト値として設定されます。
  • Swagger Validation Options
    : 公開されたサービス ポリシーで、結果の Validate Against Swagger Document アサーションを有効にするオプションを選択します。各オプションの詳細な説明については、「Validate Against Swagger Document アサーション」を参照してください。
よくある質問
質問
回答
Swagger ドキュメントをローカルまたはネットワーク ドライブ上で指定できないのはなぜですか。
swagger.json
ドキュメントは常にオンラインで提供されている必要があります。上級ユーザは、Swagger ドキュメントの内容をコンテキスト変数に貼り付けて独自のサービスを作成することも可能です。
Swagger 検証オプションを後で変更できますか。
はい。公開されたサービスで Validate Against Swagger Document アサーションを開き、適切な変更を加えるだけです。
Swagger ドキュメントをダウンロードできないのはなぜですか。
ドキュメントが有効な Swagger ドキュメントであることを確認します。また、ドキュメント サイズが
swagger.maxDownloadSize
クラスタ プロパティによって指定された最大値を超えていないことを確認します。