swagger ファイルと apiconfig ファイル

swagger ファイルと apiconfig ファイルは、スキーマの動作を直接定義しません。ただし、これらのファイルには、スキーマに関連する情報が含まれています。完全を期すために、これらのファイルをここで定義します。

swagger ファイル

Cloud API のコンテキストでは、swagger ファイルは、特定の API のエンドポイントと操作を定義します。通常は、保険会社が Cloud API swagger ファイルをコンフィギュレーションする必要はありません。

swagger ファイルは、/apis サブディレクトリに保存されます。

swagger ファイルの構文

swagger ファイルには、API を定義するセクションを含めることができます。例えば、共通 API を定義する common_pl-1.0.swagger.yaml ファイルの一部を以下に示します。

swagger: "2.0"
info:
  title: "Common API"
  description: "APIs for common InsuranceSuite platform objects like activities and notes"
  version: "1.4.0"
basePath: /common/v1
consumes:
- application/json
produces:
- application/json
Java

swagger ファイルには、エンドポイントパスとそのパスに関連する操作とリソースのセットを定義する paths セクションを含めることもできます。例えば、共通 API 内の最初のパス /activities を定義する common_pl-1.0.swagger.yaml ファイルの一部を以下に示します。

paths:
  /activities:
    get:
      summary: "Retrieve the `Activity` elements that are assigned to the caller"
      description: "Retrieves the `Activity` elements that are assigned to the caller"
      operationId: getActivities
      x-gw-extensions:
        childResourceType: Activity
        operationType: get-collection
        resourceType: Activities
      x-gw-parameter-sets:
      - get-collection
      responses:
        "200":
          description: "The paginated list of `Activity` elements"
          schema:
            $ref: "#/definitions/ActivityList"
Java

Apiconfig ファイル

Cloud API のコンテキスト内では、apiconfig ファイルは、両方のリソースを Gosu ファイルにマップするグルーファイルです。apiconfig ファイルは、コレクションのデフォルトの並べ替え順序が定義される場所でもあります。

リソースを Gosu ファイルに接続するように apiconfig ファイルをコンフィギュレーションする必要がある唯一のタイミングは、REST エンドポイントジェネレーターによって作成された CRUD エンドポイントのコンフィギュレーションを実行しているときです。詳細については、生成されたエンドポイントのグルーおよび実装クラスのコンフィギュレーションを参照してください。

デフォルトの並べ替え順序の定義の詳細については、コレクションの並べ替えを参照してください。