OpenAPI YAML ソースの検証
API の編集時に、Swagger 仕様に対して OpenAPI YAML ソースを検証する方法。
このタスクについて
API エディターで API を構成するときに、 をクリックして、 OpenAPI YAML ソースを検証できます。 Swagger パーサー検証エラーが検出されると、エラー・アイコンが表示されます。このアイコンをクリックすると、個々のエラーと、それらのエラーが YAML 内のどこで発生しているかを確認できます。 その後、エラーを修正し、更新を保存し、API 構成プロセス全体を通して OpenAPI YAML の検証を続行できます。
注:
- OpenAPI 検証では、API のステージングまたは公開を妨げるゲートウェイ・エラーやポリシー・エラーは表示されません。 このタイプの検証は、API をステージングまたは公開しようとした場合にのみ行われます。 詳しくは、 API のステージング または API の公開を参照してください。
- ガバナンス ・ルール・セットを使用して API 文書を検証することもできます。 詳しくは、 ガバナンス・サービスを使用した API または製品文書の検証を参照してください。
このタスクは、 API Designer UI アプリケーションを使用するか、ブラウザー・ベースの API Manager UI を使用して実行できます。
手順
OpenAPI YAML ソースを検証するには、以下の手順を実行します。
- 編集のために必要な API を開きます。 OpenAPI 2.0 API 定義の編集 または OpenAPI 3.0 API 定義の編集を参照してください。
- ヘッダーのメニュー・バーから をクリックします。
- swagger パーサー検証エラーが検出されると、ヘッダー・メニュー・バーにエラー・アイコンが表示され、検出された OpenAPI エラーの数がアイコンの横に表示されます。 例えば、
などです。 - その後、エラー・アイコンをクリックして、エラーの詳細リストと、YAML 内のエラーの場所を表示できます。 「フォーム」
ビューでは、個々のエラーをクリックして、フォーム内の関連する API セクションに直接ナビゲートできます。 - エラーを修正した後、 「保存」 をクリックして更新を保存し、 「検証」 を再度クリックします。
- すべてのエラーが修正されると、検証は成功メッセージを返します。 例えば、
などです。