APIスキーマ設定
APIスキーマ設定画面では、APIスキーマへのフィールドの追加や、作成したスキーマの設定の変更ができます。
APIスキーマの設定方法
- まず設定したいAPIページの右上「API設定」をクリックします。
- メニュー「APIスキーマ」をクリックして編集画面を開きます。
- 任意の変更(フィールドの追加、設定変更)を加え、「変更する」ボタンをクリックします。
- Caution
作成済みのフィールドのフィールドID/表示名/詳細設定は、任意のタイミングで変更可能です(一部の設定を除く)。ただし、APIスキーマを変更すると、既存のコンテンツAPIのレスポンスに影響がある場合があります。すでに本番環境で運用中の場合、変更にはご注意ください。
フィールドID
フィールドごとの一意なIDです。APIレスポンスのプロパティ名となります。
表示名
コンテンツを入力する際に表示されます。
種類
コンテンツを入力する際の入力フォーム形式を指定します。
テキストフィールド、リッチエディタ、画像フィールドなど様々な種類から選択可能です。
- Caution
一度作成したフィールドの種類は変更できません。変更したい場合は一度フィールドを削除し、新たに作成し直してください。
フィールドの詳細設定
必須入力項目以外に、各フィールドにおいて詳細設定が可能です。
必須項目
チェックを入れるとコンテンツ入稿する際に、「必須」の設定にできます。全フィールドで設定可能です。
詳細設定
フィールドごとに詳細設定が可能です。各フィールド右端の「詳細設定」をクリックすると、設定画面が開きます。
以下はテキストフィールドの例です。
APIスキーマ設定に反映させるには、「閉じる」で設定画面を閉じ、「変更する」ボタンをクリックします。
1. テキストフィールド
重複を許可しない(ユニーク)
他のコンテンツで同じ値がある場合にはコンテンツを保存できなくなります。1つのAPIに対して最大で5つのフィールドに設定が可能です。コンテンツに重複した値がある場合はオンに変更することはできません。
特定のパターンのみ入力を許可する
正規表現にマッチした入力のみに制限します。
文字数を制限する
フィールドに入力する文字数の最小文字数、最大文字数を制限します。
4. 旧リッチエディタ(非推奨)
装飾ボタン
使用可能な装飾ボタンを制限することができます。
改行に<br>タグを用いる
オンの場合は<br>タグで改行します。オフの場合は<p>タグで段落分けします。
画像のレスポンスにwidthとheightを含む
オンの場合は <img>
タグに width
と height
が含まれます。
- Information
「日付指定のみ」をONにした場合も、APIのレスポンスは時刻情報(
"T00:00:00.000Z"
の部分)が付与された状態で返却されます。
- Information
複数選択のオプションにつきましては、フィールドの作成以降、変更できません。変更する場合は、フィールドを作り直してください。
10. コンテンツ参照
参照先コンテンツ
参照するAPIを設定します。
一覧画面に表示する項目
コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。
- Information
参照先のAPIは設定後、途中変更することはできません。
11. 複数コンテンツ参照
参照先コンテンツ
参照するAPIを設定します。
一覧画面に表示する項目
コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。
複数コンテンツ参照の数を制限する
複数コンテンツ参照の最小数と最大数を設定します。
- Information
参照先のAPIは設定後、途中変更することはできません。
- Information
システムの制約上、数値フィールドは15桁までの数値のみ、正常に登録することが可能です。16桁以上を入力した場合は、データが変換されて登録されるケースがございますので、ご注意ください。
- カスタムフィールド
- https://document.microcms.io/manual/custom-field
14. 繰り返し
繰り返しフィールド
繰り返しフィールドに使用するカスタムフィールドを設定します。
並び順
カスタムフィールドを選択する際の並び順を設定します。
繰り返しフィールドの数を制限する
繰り返しフィールドの最小数と最大数を設定します。
- 繰り返しフィールド
- https://document.microcms.io/manual/repeat-field
- Information
ファイルフィールドはTeamプラン以降でご利用いただけます。
- 拡張フィールド
- https://document.microcms.io/manual/iframe-field