USER MANUALS


OpenAPI 3 のデータソースの FAQ

JSON データソースと XML データソースは OpenAPI 3 に対応しています。これは、サービス操作を基本ビューとしてインポートする便利な方法です (「 JSON ソース 」および「 XML ソース 」を参照してください)。XML データソースや JSON データソースで OpenAPI 3 を使用する場合に役立つ情報をまとめています。

  • OpenAPI 2: OpenAPI 2/Swagger ドキュメントは直接サポートされていませんが、通常は OpenAPI 2/Swaggerドキュメントを OpenAPI 3 に変換できます。変換する前に、OpenAPI 2/Swagger ドキュメントを検証し、(まだ YAML 形式でない場合は) Swagger Editor を使用して YAML に変換することをお勧めします。OpenAPI 2/Swagger ドキュメント全体が有効で、エラーがなく OpenAPI 3 に変換できるようにするには、ドキュメントの微調整が必要な場合があります。バージョン 2 からバージョン 3 に変換するには、OpenAPI 2 の仕様を Swagger Editor に貼り付け、[Edit] > [Convert To OpenAPI 3] をクリックします (変換ツールは他にもあるため、適宜ツールを選択します)。

  • OpenAPI 3 ドキュメントからのデフォルト値の読み込み: OpenAPI 3 を使用するように構成されている JSON と XML データソースのウィザードにある [Default configuration for base views] > [Configure] > [Load default values from OpenAPI3 Specification] ボタンで、OpenAPI 3 ドキュメントで定義されているベース URI を取得します。検討が必要な特殊なケースもあります。

    • 相対 URI: OpenAPI 3 ドキュメントで定義されているベース URI が相対 URI の場合、実際のホスト名を URI に追加する必要があります (あるいは、このオプションを利用できる場合は、インポートする前に OpenAPI 3 ドキュメントで URI を直接変更します)。

    • 変数付きの URI: OpenAPI 3ドキュメントでは、ベース URI を変数参照 (https://url.{var}.com など) で定義できます。この場合は、手動で特定の値に置き換える必要があります。利用可能な値のリストは、OpenAPI 3 ドキュメントにあります (Swagger Editor を使用して、利用可能なオプションを簡単にチェックできます)。

  • 必要な HTTP ヘッダー: サービスによっては、リクエストごとに特定の HTTP ヘッダーが必要です。XML と JSON データソースのウィザードでは、自動的に適切な値の Accept ヘッダーと Content-Type ヘッダーを構成に追加します。サービスで必要な他の HTTP ヘッダーは、[Default configuration for base views] > [Configure] > [HTTP headers] で手動で追加する必要があります。

  • 基本ビューとしてインポートできない操作: OpenAPI 3 ドキュメントで定義されているサービス操作の中には、基本ビューとしてインポートできないものがあります (該当の操作の場合、その具体的な理由を示すツールチップがイントロスペクションツリーに表示されます)。これには主に 2 つの理由があります。

    • データソース (JSON または XML) と互換性のあるデータ型を返すことができません。

    • 操作に定義されている応答スキーマや本文スキーマがサポートされていないため、Virtual DataPort ビュースキーマに変換できません。たとえば、複数のスキーマを参照するキーワード 「oneOf」と「anyOf」 は、 フリーフォームオブジェクト と同様、VDP ではサポートされません。

  • OpenAPI 3 ドキュメントにアクセスするには、カスタムヘッダーまたはサポートされていない認証スキームが必要: 現在、リモートの OpenAPI 3 ドキュメントにアクセスするために、カスタム HTTP ヘッダーや HTTP Basic または HTTP Digest 以外の認証スキームを定義することはできません。この場合、サービスの Web サイトから OpenAPI 3 ドキュメントをダウンロードし、ローカルアクセスを構成できます。

Add feedback