microCMS

APIの作成

最終更新日: 2020/04/22

APIの作成について解説していきます。
APIはサービスごとに複数作成することができます。
プランごとに作成できるAPI数の上限は異なります。)

まずは基本情報の入力です。



ここでは、API名 / エンドポイントの2つを入力します。

API名は管理画面上で各APIを識別するために設定する名前になります。
エンドポイントはAPIのエンドポイントの最後尾のパスにあたる値です。
エンドポイントの入力条件は以下になります。

  • 3文字以上20文字以内
  • 半角英数字
  • 小文字のみ
  • 記号はハイフン、アンダースコアのみ
  • すでに設定済みのAPIエンドポイントとの重複不可


ここでは例として、お知らせ情報を取得するAPIを作成します。
次に、APIのレスポンス形式の指定です。



ここではAPIレスポンスをリスト形式で返すか、オブジェクト形式で返すか選択することができます。

リスト形式

複数のコンテンツを取り扱います。
お知らせやブログなどの複数コンテンツの管理に適しています。
APIでは下記のように配列データを取得できます。

[ { message: 'おはよう' }, { message: 'こんにちは' }, { message: 'こんばんは' } ]


オブジェクト形式

単一のコンテンツを取り扱います。
設定情報や単体ページの情報などの単一コンテンツの管理に適しています。
APIでは下記のようにオブジェクトデータを取得できます。

{ title: 'プロフィール', profile: 'ヘッドレスCMSを勉強しています' }


例として、お知らせ情報は複数コンテンツから成り立つのでリスト形式を選択します。
次にAPIスキーマの設定です。



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

フィールドID

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

表示名

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

種類

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

以上でAPIの作成は完了です。