Merge pull request #76 from microcmsio/auto-update-docs-20250917T020022

ドキュメントの更新を同期

Author: himaratsu

docs/manual/APIの作成・管理.md

@@ -0,0 +1,189 @@
+---
+contentId: create-api
+directory: manual
+---
+
+# APIの作成・管理
+
+APIはサービス内で複数作成することができます。  
+本ドキュメントでは、APIの作成・管理方法を説明します。
+
+作成できるAPI数の上限は[プラン](https://microcms.io/pricing)ごとに異なります。
+
+APIを作成する手順
+==========
+
+新規にAPIを作成する手順を説明します。  
+  
+まず、管理画面左側のメニュー内で、「コンテンツ（API）」項目の3点リーダーをクリックし**［新しいAPIを作成］**をクリックします。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/d7d24ee831424b46a5c2921ba9554b38/CleanShot%202025-07-17%20at%2010.38.02.png)  
+  
+すると、APIの作成画面が表示されます。  
+※APIが存在しない場合は、サービスにアクセス後、自動でAPIの作成画面が表示されます。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/f37ce227419e4799973f48ed795c4292/api%E3%83%86%E3%83%B3%E3%83%97%E3%83%AC%E3%83%BC%E3%83%88%E3%81%AE%E9%81%B8%E6%8A%9E.png)  
+  
+APIを作成する際は、以下の2つの方法から選んで作成します。
+
+1.  自分で決める
+2.  テンプレートから選ぶ（ブログ／お知らせ／バナー）
+
+以降、それぞれの方法について説明します。
+
+自分で決める場合
+--------
+
+APIの作成画面で**［自分で決める］**をクリックします。  
+その後、以下の手順で進めます。  
+
+### 1\. APIの基本情報を入力する
+
+APIの基本情報を入力します。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/338138e97fa04a018029417883bfbb9d/CleanShot%202024-08-16%20at%2014.32.35%402x.png)  
+  
+ここでは、「API名」および「エンドポイント」の2つを入力します。  
+
+#### API名
+
+API名は管理画面上で各APIを識別するための名前です。
+
+#### エンドポイント
+
+エンドポイントはAPIのエンドポイントの最後尾のパスにあたる値です。  
+エンドポイントの入力条件は以下のとおりです。
+
+*   3文字以上32文字以内
+*   半角英数字
+*   小文字のみ
+*   記号はハイフン、アンダースコアのみ
+*   すでに設定済みのAPIエンドポイントとの重複不可
+
+### 2\. APIの型を選択する
+
+APIの型を選択します。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/58654b8b67c142a394a1e64d15c12ded/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%88%202023-03-27%2014.57.46.png)  
+  
+ここではAPIレスポンスの形式について、「**リスト形式**」か「**オブジェクト形式**」かを選択することができます。  
+
+#### リスト形式
+
+複数のコンテンツを取り扱います。  
+お知らせやブログなどの複数コンテンツの管理に適しています。  
+APIでは下記のように配列データを取得できます。
+
+    [ { message: 'おはよう' }, { message: 'こんにちは' }, { message: 'こんばんは' } ]
+
+####   
+オブジェクト形式
+
+単一のコンテンツを取り扱います。  
+設定情報や単体ページの情報などの単一コンテンツの管理に適しています。  
+APIでは下記のようにオブジェクトデータを取得できます。
+
+    { title: 'プロフィール', profile: 'ヘッドレスCMSを勉強しています' }
+
+### 3\. APIスキーマを定義する
+
+APIスキーマを定義します。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/14e01ce40c9843ff8505f3784fd64410/CleanShot%202024-08-16%20at%2014.34.23%402x.png)  
+  
+APIスキーマの定義では、下記3つの項目を入力します。  
+
+#### フィールドID
+
+フィールドごとの一意なIDです。APIレスポンスのプロパティ名となります。
+
+#### 表示名
+
+コンテンツを入力する際に表示されます。
+
+#### 種類
+
+コンテンツを入力する際の入力フォーム形式を指定します。  
+テキストフィールド、リッチエディタ、画像フィールドなど様々な種類から選択可能です。
+
+APIスキーマの設定について、詳しくは「[API設定](https://document.microcms.io/manual/api-model-settings#hbf58befd50)」のページをご覧ください。
+
+### 4\. ［作成］をクリックする
+
+最後に［作成］をクリックすると、APIの作成が完了します。
+
+  
+
+テンプレートから作る場合
+------------
+
+テンプレートから作る場合、以下の3つのテンプレートから選ぶことができます。テンプレートごとに異なるAPIが作成されます。  
+
+*   **ブログ**：ブログ用のテンプレート。記事とカテゴリのAPIを作成します。
+*   **お知らせ**：更新情報やニュースの用のテンプレート。お知らせとタグのAPIを作成します。
+*   **バナー**：キャンペーンなど、バナー用のテンプレート。バナー要素のAPIを作成します。
+
+  
+対象のテンプレートをクリックすると作成が始まります。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/7d5ef3840bcd4c9cb8c830343938c175/CleanShot%202024-08-16%20at%2014.26.14%402x.png)  
+  
+しばらくすると、APIが自動で作成されます。  
+なお、APIごとにいくつかのサンプルコンテンツが入稿されています。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/f602d6fc28d64135886ab23f773cee03/CleanShot%202024-08-16%20at%2014.35.56%402x.png)
+
+作成したAPIをグルーピングする
+================
+
+  
+作成したAPIは、APIグループでまとめることができます。複数のサイトを1サービスで管理している場合などに便利です。
+
+APIグループはTeamプラン、Businessプラン、Enterpriseプランでご利用いただける機能です。  
+プランごとに利用できる機能については、[料金プランページ](https://microcms.io/pricing)をご覧ください。
+
+  
+APIグループを作成する
+---------------
+
+  
+管理画面左側のメニュー内で、「コンテンツ（API）」項目の3点リーダーをクリックし**［新しいAPIグループを作成］**をクリックします。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/8159c7579a934851add0c710d206d797/CleanShot%202025-07-17%20at%2011.17.19.png)
+
+*   APIグループは100個まで作成できます。
+*   APIグループは1階層のみ対応しています。
+
+作成するグループのグループ名を入力し**［作成する］**をクリックします。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/ccffca94174344fb882f6f909861848e/image.png)
+
+同じ名前のAPIグループは作成できません。
+
+APIをドラッグ&ドロップで移動させることで、APIをAPIグループにまとめることができます。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/76beccf1788f4cad99439d86ed79e666/CleanShot%202025-07-17%20at%2011.27.27.gif)  
+
+APIグループの名称を変更する
+---------------
+
+  
+APIグループにマウスカーソルを合わせると表示される3点リーダーをクリックし**［グループ名の編集］**をクリックします。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/65ec79f0481949fcaccffa704d7b1caa/CleanShot%202025-07-17%20at%2011.30.35.png)  
+  
+グループ名を編集して**［変更する］**をクリックすると、グループ名の変更を反映できます。  
+
+APIグループを削除する
+------------
+
+  
+APIグループにマウスカーソルを合わせると表示される3点リーダーをクリックし**［グループの削除］**をクリックします。  
+  
+![](https://images.microcms-assets.io/assets/d6af1616730544a596d299c20834f460/4a75bfae027d47ac86e1e8606236b257/CleanShot%202025-07-17%20at%2019.44.25.png)  
+  
+確認ダイアログで**［OK］**をクリックすると、APIグループを削除できます。
+
+APIグループにAPIが所属している場合は、APIグループを削除できません。
+
+APIを他のAPIグループにすべて移動させてから削除してください。