microCMS

APIスキーマ設定

最終更新日:2024年05月21日

APIスキーマ設定画面では、APIスキーマへのフィールドの追加や、作成したスキーマの設定の変更ができます。

APIスキーマの設定方法

  1. まず設定したいAPIページの右上「API設定」をクリックします。
  2. メニュー「APIスキーマ」をクリックして編集画面を開きます。
  3. 任意の変更(フィールドの追加、設定変更)を加え、「変更する」ボタンをクリックします。

cautionCaution

作成済みのフィールドのフィールドID/表示名/詳細設定は、任意のタイミングで変更可能です(一部の設定を除く)。ただし、APIスキーマを変更すると、既存のコンテンツAPIのレスポンスに影響がある場合があります。すでに本番環境で運用中の場合、変更にはご注意ください。

フィールドの追加方法

  1. フィールドのリスト最下部にある「フィールドを追加」ボタンを押下します。
  2. フィールドID/表示名/種類をそれぞれ入力します(必須)。


フィールドID

フィールドごとの一意なIDです。APIレスポンスのプロパティ名となります。

表示名

コンテンツを入力する際に表示されます。

種類

コンテンツを入力する際の入力フォーム形式を指定します。
テキストフィールド、リッチエディタ、画像フィールドなど様々な種類から選択可能です。

cautionCaution

一度作成したフィールドの種類は変更できません。変更したい場合は一度フィールドを削除し、新たに作成し直してください。


フィールドの詳細設定

必須入力項目以外に、各フィールドにおいて詳細設定が可能です。

必須項目

チェックを入れるとコンテンツ入稿する際に、「必須」の設定にできます。全フィールドで設定可能です。

詳細設定

フィールドごとに詳細設定が可能です。各フィールド右端の「詳細設定」をクリックすると、設定画面が開きます。



以下はテキストフィールドの例です。



APIスキーマ設定に反映させるには、「閉じる」で設定画面を閉じ、「変更する」ボタンをクリックします。

フィールドごとに設定できる項目

全フィールド共通の項目

必須項目

設定がONの場合、フィールドへのデータ入力が必須となります。

説明文

管理画面のフィールドの上部に表示される説明文です。

1. テキストフィールド

重複を許可しない(ユニーク)

他のコンテンツで同じ値がある場合にはコンテンツを保存できなくなります。1つのAPIに対して最大で5つのフィールドに設定が可能です。コンテンツに重複した値がある場合はオンに変更することはできません。

特定のパターンのみ入力を許可する

正規表現にマッチした入力のみに制限します。

informationInformation

利用可能な正規表現のパターンには制限があります。詳しくは「入力文字列の制限で利用可能な正規表現のパターンは?」をご参照ください。

文字数を制限する

フィールドに入力する文字数の最小文字数、最大文字数を制限します。

2. テキストエリア

特定のパターンのみ入力を許可する

正規表現にマッチした入力のみに制限します。

informationInformation

利用可能な正規表現のパターンには制限があります。詳しくは「入力文字列の制限で利用可能な正規表現のパターンは?」をご参照ください。

文字数を制限する

フィールドに入力する文字数の最小文字数、最大文字数を制限します。

3. リッチエディタ

ツールバーの編集

使用可能なツールバーのボタンを制限することができます。

カスタムクラス

登録したclass名を特定のテキスト要素に付与できます。

4. 旧リッチエディタ(非推奨)

装飾ボタン

使用可能な装飾ボタンを制限することができます。

改行に<br>タグを用いる

オンの場合は<br>タグで改行します。オフの場合は<p>タグで段落分けします。

画像のレスポンスにwidthとheightを含む

オンの場合は <img> タグに widthheight が含まれます。

5. 画像

画像のサイズ制限

フィールドに入力する画像のwidth、heightの値を制限します。

6. 複数画像

画像のサイズ制限

フィールドに入力する画像の widthheight の値を制限します。

レイアウト

管理画面での表示をカスタマイズできます。

7. 日時

日付指定のみ

設定をONにすると時間の指定はできなくなります。

informationInformation

「日付指定のみ」をONにした場合も、APIのレスポンスは時刻情報("T00:00:00.000Z"の部分)が付与された状態で返却されます。


8. 真偽値

初期値

入稿時の初期値を選択できます。

9. セレクトフィールド

選択肢

セレクトフィールドの選択肢を設定します。

複数選択

ONに設定すると、項目の複数選択が可能になります。

初期値

入稿時の初期値を選択できます。

informationInformation

複数選択のオプションにつきましては、フィールドの作成以降、変更できません。変更する場合は、フィールドを作り直してください。


10. コンテンツ参照

参照先コンテンツ

参照するAPIを設定します。

一覧画面に表示する項目

コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。

informationInformation

参照先のAPIは設定後、途中変更することはできません。


11. 複数コンテンツ参照

参照先コンテンツ

参照するAPIを設定します。

一覧画面に表示する項目

コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。

複数コンテンツ参照の数を制限する

複数コンテンツ参照の最小数と最大数を設定します。

informationInformation

参照先のAPIは設定後、途中変更することはできません。


12. 数字

数値を制限する

フィールドに入力する数値の最小値、最大値を制限します。

informationInformation

システムの制約上、数値フィールドは15桁までの数値のみ、正常に登録することが可能です。16桁以上を入力した場合は、データが変換されて登録されるケースがございますので、ご注意ください。


13. カスタム

カスタムフィールド

使用するカスタムフィールドを設定します。

カスタムフィールド
https://document.microcms.io/manual/custom-field


14. 繰り返し

繰り返しフィールド

繰り返しフィールドに使用するカスタムフィールドを設定します。

並び順

カスタムフィールドを選択する際の並び順を設定します。

繰り返しフィールドの数を制限する

繰り返しフィールドの最小数と最大数を設定します。

繰り返しフィールド
https://document.microcms.io/manual/repeat-field


15. ファイル

フィールド特有の設定項目なし

informationInformation

ファイルフィールドはTeamプラン以降でご利用いただけます。


16. 拡張フィールド

拡張フィールド URL

拡張フィールドに使用するURLを設定します。

拡張フィールド
https://document.microcms.io/manual/iframe-field