RAML ベースの API の特性およびポリシーの概念

ユーザーが参照する必要がある RAML 定義を API が公開する場合、RAML 定義には、API に対するコールで想定されるすべての要素の詳細を確実に含める必要があります。たとえば、クライアント ID ベースのポリシーを適用すると、API に対するすべての要求にクライアント ID とクライアントシークレット (デフォルトでクエリパラメーターとして想定される) が含まれていることを意味します。ユーザー要求が却下されることを防止するため、RAML ルートに特性を作成し、API のすべての操作でこの特性を参照します。特性は次のようになります。

traits:
  - client-id-required:
      queryParameters:
        client_id:
          type: string
        client_secret:
          type: string

次に、個々の操作で次のようにこの特性を適用できます。

/products:
  get:
    is: [client-id-required]
    description: Gets a list of all the inventory products.

API ダッシュボードで [Policies (ポリシー)] をクリックします。

ポリシーリストの RAML スニペットリンクには、RAML に追加する必要がある RAML コードが含まれています。
[RAML Snippet (RAML スニペット)] をクリックします。
API RAML バージョンに合わせて、RAML 0.8 または RAML 1.0 を選択します。
API を編集してコードを追加します。
API を再デプロイします。

RAML ベースの API の特性およびポリシーの概念

関連情報