# データ型属性を使用

以下のテーブルには異なるデータ型に定義できる属性が表示されます。

## 一般属性

これらの属性はすべてのデータ型で使用できます。

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Name] (名前) | データ型名またはプロパティ名。 | データ型またはプロパティ定義のルートエレメント。 |
| [Description] (説明) | プロパティの説明。 | 説明 |
| 必須の有無 | ブール値。プロパティが必須かどうかを定義します。 | <ul> <li>OAS 3.0とSwagger 2.0: 必須であるプロパティは、オブジェクトレベルで<span>required</span>エレメントにリスト表示されます。</li> <li>RAML: <span>required</span> </li> </ul> |
| 制限 | リクエスト、レスポンスまたは両方でプロパティを使用できるかどうかを定義します。 | <ul> <li>OAS 3.0: プロパティにブール値を使う<span>writeOnly</span>エレメントまたは<span>readOnly</span>エレメントを指定できます。</li> <li>Swagger 2.0またはRAML 1.0には、対応するエレメントがありません。</li> </ul> |
| 例 | プロパティのサンプル値。APIモックを使う場合は返されます。 | <ul> <li>OAS 3.0とSwagger 2.0: <span>[example] (サンプル)</span>エレメントで一番目の値が使用されます。その他の値は無視されます。 <div><span>情報メモ</span><span>注:</span> OAS 3.0仕様には<span>examples</span>エレメントが含まれていますが、<span>Talend Cloud API Designer</span>ではサポートされていません。</div> </li> <li>RAML: <span>examples</span> </li> </ul> |

## オブジェクト属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Additional Properties] (追加のプロパティ) | ブール値。データ型定義に含まれていないプロパティタイプをオブジェクトが受け入れるかどうかを定義します。これはデフォルトで有効になっています。 | additionalProperties |

## 配列属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Min items] (アイテムの最小数)と[Max items] (アイテムの最大数) | 配列内のアイテムの最小数と最大数。 | minItemsとmaxItems |
| [Unique items] (一意のアイテム) | ブール値。配列内の各アイテムが一意である必要があるかどうかを定義します。 | <ul> <li>OAS 3.0とRAML 1.0: <span>uniqueItems</span> </li> <li>Swagger 2.0には、対応するエレメントがありません。</li> </ul> |

## 文字列属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Enum] (列挙型) | プロパティの可能な値。 | enum |
| [Min length] (最小長)と[Max length] (最大長) | 値のバイトの最小数と最大数。 | minLengthとmaxLength |
| パターン | 値が一致するべき正規表現。 | パターン |
| デフォルト | 値がない場合に使う値。 | デフォルト |

## 番号属性と整数属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Enum] (列挙型) | プロパティの可能な値。 | enum |
| [Format] (形式) | 数字または整数に使う形式。 | format |
| [Minimum] (最小値)と[Maximum] (最大値) | 数字または整数の最小値と最大値。 | [Minimum] (最小値)と[Maximum] (最大値) |
| デフォルト | 値がない場合に使う値。 | デフォルト |

## 日時属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Enum] (列挙型) | プロパティの可能な値。 | enum |
| デフォルト | 値がない場合に使う値。 | デフォルト |

## 日時属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Enum] (列挙型) | プロパティの可能な値。 | enum |
| [Format] (形式) | 日時に使う形式。 | <ul> <li>RAML 1.0: <span>format</span> </li> <li>OAS 3.0: OAS 3.0の日時のプロパティは、<span>date-time</span>という形式の文字列として定義されています。デフォルトで使われる日時形式はRFC3339ですが、<kbd>rfc2616</kbd>が選択されている場合は<span>date-time-rfc2616</span>というカスタム形式が使われます。</li> <li>Swagger 2.0: 日時のプロパティはOAS 3.0の場合と同様に定義されていますが、Swagger 2.0ではカスタム形式がサポートされていません。選択された形式にかかわらず、RFC3339として解釈されます。</li> </ul> |

## ファイル属性

| フィールド | 説明 | 対応するOAS/SwaggerとRAMLエレメント |
| --- | --- | --- |
| [Min length] (最小長)と[Max length] (最大長) | 値のバイトの最小数と最大数。 | minLengthとmaxLength |
| [File types] (ファイルタイプ) | \*/\*という形式で使うファイルのタイプ。例: image/png | <ul> <li>RAML 1.0: <span>fileTypes</span> </li> </ul> |