microCMS "APIの作成方法"

はじめに

前回に引き続き、今回はmicroCMSのAPIの作成方法について書いていきます.

APIの作成

1. 基本情報の入力

アカウント登録が終了した後の画面です.
API名、エンドポイントを入力していきましょう.
自分は以下のようにしました.


2. APIの型の選択

リスト形式とオブジェクト形式から選べます.
例を示すと以下のようになります.

  • リスト形式
    [ { hoge: 'ホゲ' }, { fuga: 'フガ' }, { piyo: 'ピヨ' } ]

  • オブジェクト形式
    { title: 'マイブログ', description: '説明', greeting: 'はじめまして!' }

今回取り扱う”ブログ”はリスト形式で作成していきます.


3. APIスキーマの定義

続いてフィールド名、表示名、種類を入力していきます.
テーブルを増やしたい場合は画像下部にある+追加ボタンを押します.

ちなみに”種類”には、次のようにさまざまなものから選択が可能です.

自分は以下のような設定にしました.

フィールドID 表示名 種類
title タイトル テキストフィールド
tags タグ 複数コンテンツ参照
cover サムネイル 画像
content 本文 リッチエディタ


4. “コンテンツ管理”から確認

APIスキーマの定義が完了すると”コンテンツ管理”のが画面が開きます.
ここで先ほど設定した項目についてきちんと登録できているか確認しましょう.

おわりに

今回は、microCMSのAPI作成について書きました.
次回はAPI経由でデータを取得する際の方法について書こうと思います.

参考

web