Headless CMS の Strapi をインストールからAPIエンドポイント作成

概要

本記事では、OSS の Headless CMS である Strapi を使用して、API を構築した際の記録です。

npm install -g strapi

もしくは

yarn global add strapi

strapi new my-project

my-project の部分は任意のプロジェクト名に置き換えてください。

cd my-project
npm run develop

もしくは

cd my-project
yarn develop

これにより、Strapi が起動し、 http://localhost:1337 でアクセスできるようになります。

次に、コレクションを作成します。コレクションは、API エンドポイントに対応するデータベースのテーブルのようなものです。 API に公開したい情報に対応するコレクションを作成します。

またオプションでは次のような設定が利用できます。

COLLECTION TYPES の設定であるコレーションタイプ(collation type)は、以下のオプションを持っています。

BASIC SETTINGS:
- Name: コレクションタイプの名前を入力します。この名前は、管理画面で表示されるための名前です。
- Displayed name: コレクションタイプの表示名を設定します。この表示名は、フロントエンドの画面で表示される名前として使用されます。
- API ID (Singular): API において、単数形で使用される識別子を設定します。
- API ID (Plural): API において、複数形で使用される識別子を設定します。
ADVANCED SETTINGS:
- Draft & publish: コレクションタイプに対して、下書き機能や公開機能を有効にするかどうかを設定します。
- Internationalization: コレクションタイプに対して、複数言語に対応するための設定を行います。この設定を有効にすると、複数の言語でコンテンツを作成することができます。

「Roles & Permissions」から、新規ロールを作成します。
「Users」から、API を使用するユーザーを作成し、先に作成したロールを割り当てます。
「Settings」→「Users & Permissions」→「Roles」で先程作成したロールを選択し、「Permissions」タブで、「Application」→「plugins」→「users-permissions」→「controllers」→「auth」→「auth.js」を選択して、「find」、「findone」、「count」の権限を許可します。
「Settings」→「Users & Permissions」→「Roles」で先程作成したロールを選択し、「Permissions」タブで、先程作成したコレクションの API エンドポイントの権限を許可します。
「Content-Type Builder」から、先程作成したコレクションの API を有効にします。

これで API エンドポイントを利用して、コレクションのデータを取得、作成、更新、削除などができます。

詳細は公式ドキュメントをご覧ください。