microCMS

APIスキーマ設定

APIスキーマ設定画面

APIスキーマの設定方法を説明します。
APIスキーマを設定・編集するには、まず設定したいAPIページの右上「API設定」をクリックします(①)。
メニュー「APIスキーマ」をクリックして編集画面を開きます(②)。
この画面でAPIスキーマの様々な詳細設定ができます。

Information

APIスキーマを編集すると、既存のコンテンツAPIのレスポンスに影響があります。

APIスキーマ設定

APIレスポンスの構造を決めることができます。
下記3つの項目を入力します。


フィールドID

APIレスポンスのプロパティ名です。

表示名

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

種類

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

APIスキーマ詳細設定

各フィールドでは、それぞれ様々な設定ができます。
各フィールド右端のメニューから詳細設定画面を開くことができます。


  • 必須項目・・・チェックを入れるとコンテンツ入稿する際に、「必須」の設定にできます。全フィールドで設定することができます。
  • 詳細設定・・・クリックすると、フィールドごとに細かい設定ができます。

詳細設定を開くとフィールドごとに以下のような画面が開きます(以下はテキストフィールドの例)。
フィールドごとに詳細設定をすることができます。



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

フィールドの詳細設定項目

各フィールドで設定できる項目です。

テキストフィールド

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 重複を許可しない(ユニーク)・・・他のコンテンツで同じ値がある場合にはコンテンツを保存できなくなります。1つのAPIに対して最大で5つのフィールドに設定が可能です。
  • 特定のパターンのみ入力を許可する・・・正規表現にマッチした入力のみに制限します。
  • 文字数を制限する・・・フィールドに入力する文字数の最小文字数、最大文字数を制限します。

テキストエリア

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 特定のパターンのみ入力を許可する・・・正規表現にマッチした入力のみに制限します。
  • 文字数を制限する・・・フィールドに入力する文字数の最小文字数、最大文字数を制限します。

リッチエディタ

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 装飾ボタン・・・使用可能な装飾ボタンを制限することができます。
  • 改行に<br>タグを用いる・・・オンの場合は<br>タグで改行します。オフの場合は<p>タグで段落分けします。
  • 画像のレスポンスにwidthとheightを含む・・・オンの場合は<img>タグにwidthとheightが含まれます。


画像

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 画像のサイズ制限・・・フィールドに入力する画像のwidth、heightの値を制限します。

日時

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 日付指定のみ・・・設定をONにすると時間の指定はできなくなります。

真偽値

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。

セレクトフィールド

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 選択肢・・・セレクトフィールドの選択肢を設定します。
  • 複数選択可・・・チェックをつけると複数選択可能になります。

コンテンツ参照

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 参照先コンテンツ・・・参照するコンテンツAPIを設定します
  • 一覧画面に表示する項目・・・コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。


複数コンテンツ参照

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 参照先コンテンツ・・・参照するコンテンツAPIを設定します
  • 一覧画面に表示する項目・・・コンテンツID、またはテキストフィールドの項目から選択できます。指定した項目が存在しない場合は、コンテンツIDが代わりに表示されます。
  • 複数コンテンツ参照の数を制限する・・・複数コンテンツ参照の最小数と最大数を設定します。


数値

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 数値を制限する・・・フィールドに入力する数値の最小値、最大値を制限します。


カスタム

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • カスタムフィールド・・・使用するカスタムフィールドを設定します。
カスタムフィールド
https://document.microcms.io/manual/custom-field

繰り返し

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 繰り返しフィールド・・・繰り返しフィールドに使用するカスタムフィールドを設定します。
  • 並び順・・・カスタムフィールドを選択する際の並び順を設定します。
  • 繰り返しフィールドの数を制限する・・・繰り返しフィールドの最小数と最大数を設定します。


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

ファイル

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
Information

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

拡張フィールド

  • 必須項目・・・設定をONにすると入稿時の入力が必須となります。
  • 説明文・・・入稿画面に表示する説明文です。入稿者にとってわかりやすい説明を入力しましょう。
  • 拡張フィールド URL・・・拡張フィールドに使用するURLを設定します。
拡張フィールドによる外部データ連携(旧: iframeフィールド)
https://document.microcms.io/manual/iframe-field