OpenAPI (Swagger 2.0) 仕様に対する IBM 拡張

x-ibm-configuration 拡張の構造は以下のとおりです。

x-ibm-configuration:
  enforced: enforced_boolean
  phase: Phase
  testable: test_boolean
  cors:
    enabled: cors_boolean
  assembly:
    execute:
      - assembly_component
   properties:
      properties_extension
   catalogs:
      catalogs_extension

以下の表に、API Connect で使用されるさまざまな拡張をリストし、それぞれの拡張について、必須であるか、用途と動作の説明、およびタイプを示します。

以下の例に示す API の x-ibm-extension セクションでは、API が、API Connect によって強制されること、realized 状態にあること、開発者ポータルでテスト・ツールを使用してテストできること、CORS アクセス制御が有効であること、および URL を呼び出して要求または応答のフィールドを編集する単純なアセンブリーを含んでいることが記述されています。

x-ibm-configuration:
  enforced: true
  phase: realized
  testable: true
  cors:
    enabled: true
  assembly:
    execute:
      - invoke:
          title: Example Invoke
          target-url: 'https://example.com/api'
          description: Example description
      - redact:
        actions:
          - action: redact
            from: 
              - request
              - response
            path: //*[@name='secondaryAddress']/*[@name='streetAddress']
  properties:
    ID:
      value: 1234
      description: An ID to be used for validating.
      encoded: false
  catalogs:
    Sandbox:
      properties:
        ID: 5678