---
schema_version: "1"
id: 321288bfd783a9dcc0eec5ce1b4a4dd8d92fa4b7365b790a4a8298ec60498475
title: RAML ベースの API の特性およびポリシーの概念
collection: mulesoft
version: current
locale: ja-jp
portal_url: https://docs.salesforce.com/mulesoft/current/ja-jp/mule-gateway/policies-mule3-prepare-raml.md
canonical_url: https://docs.mulesoft.com/jp/mule-gateway/policies-mule3-prepare-raml
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 382997e3055e7749828bf5273aa483e9695151ed929ab50451ecc927c74a928c
description: MuleSoft Documentation Site
latest: true
---
# RAML ベースの API の特性およびポリシーの概念

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

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

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

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

1. API ダッシュボードで \[Policies (ポリシー)\] をクリックします。
    
    ポリシーリストの RAML スニペットリンクには、RAML に追加する必要がある RAML コードが含まれています。
    
    ![API ポリシーの詳細が示されているテーブル](/mulesoft/current/ja-jp/mule-gateway/_images/raml-snippet.png)
2. \[RAML Snippet (RAML スニペット)\] をクリックします。
3. API RAML バージョンに合わせて、RAML 0.8 または RAML 1.0 を選択します。
4. API を編集してコードを追加します。
5. API を再デプロイします。

## [](#関連情報)関連情報

- [提供ポリシー](https://docs.mulesoft.com/jp/mule-gateway/policies-mule3-available-policies)