Anypoint DataGraph ベストプラクティスルールセット

DataGraph ベストプラクティスルールセットは、Anypoint DataGraph で使用する API プロジェクトに連動関係として追加できるガバナンスルールのコレクションです。このルールセットは、API プロジェクトが DataGraph のベストプラクティスに従うためのメッセージのコレクションです。このルールセットは Exchange で公開されており、Design Center API Designer で API 仕様に連動関係として追加します。API Governance CLI を使用してルールセットに対して API を検証することもできます。

使用例

次の example-api.raml を考えてみます。

#%RAML 1.0

title: DOCS - Order API

types:
  Order:
    description: An Order
    properties:
      orderId:
        description: The ID of the order
        type: string
    additionalProperties: false


/orders/{orderId}:
  get:
    responses:
      200:
        body:
          application/xml:
            type: Order

DataGraph ベストプラクティスルールセットを適用すると、次の警告メッセージが表示されます。

example-api.raml (16:3) ⚠️Warning: [Datagraph Best Practices] Only JSON payloads are supported at the moment in DataGraph. This is the preferred media type format.

このメッセージは、GET コマンドの application/xml が application/json である必要があることを示しています。

API Designer でのルールセットの追加と使用についての詳細は、「API 定義内の API 準拠の問題を検出」を参照してください。