エンドポイント管理
エンドポイントの作成、編集、削除について説明します。
エンドポイントとは
エンドポイントはコンテンツの「種類」を定義します。APIでコンテンツを取得する際のパスとしても使用されます。
例
| エンドポイント名 | パス名 | API URL |
|---|---|---|
| ニュース | news | /api/v1/news |
| ブログ | blog | /api/v1/blog |
| お知らせ | announcements | /api/v1/announcements |
エンドポイント一覧
サービスを選択すると、左サイドバーにエンドポイント一覧が表示されます。
エンドポイントの作成
権限
エンドポイントの作成には Admin 権限が必要です。
- サイドバーの「+ エンドポイント追加」をクリック
- 以下の項目を入力:
| 項目 | 説明 | 例 |
|---|---|---|
| パス名 | APIのパスとして使用される識別子 | news |
| 表示名 | 管理画面に表示される名前 | ニュース |
- 「作成」をクリック
パス名のルール
- 小文字英字（a-z）
- 数字（0-9）
- ハイフン（-）
- アンダースコア（_）
命名のコツ
- 英語で簡潔に:
news,blog,products - 複数形が一般的:
articles,events - ハイフン区切り:
press-releases
エンドポイントの編集
- サイドバーでエンドポイントを選択
- エンドポイント詳細画面で「編集」をクリック
- 表示名を変更
- 「保存」をクリック
パス名の変更
パス名は作成後に変更できません。変更が必要な場合は、新しいエンドポイントを作成してコンテンツを移行してください。
エンドポイントの削除
注意
エンドポイントを削除すると、そのエンドポイントに属するすべてのコンテンツも削除されます。この操作は取り消せません。
- エンドポイント詳細画面で「削除」をクリック
- 確認ダイアログで「削除する」を選択
必要な権限
| 操作 | 必要な権限 |
|---|---|
| 一覧表示 | Read 以上 |
| 作成 | Admin |
| 編集 | Admin |
| 削除 | Admin |