基本概念
iwa-cms を理解するための基本的な概念を説明します。
サービス
サービスは「テナント」や「プロジェクト」に相当する最上位の単位です。
- 1つのサービス = 1つのWebサイトやアプリケーション
- サービスごとに独立したコンテンツ、メンバー、APIキーを管理
- 複数のサービスを1つのCMSで運用可能
例
- 「コーポレートサイト」サービス
- 「ECサイト」サービス
- 「社内ポータル」サービス
エンドポイント
エンドポイントはコンテンツの「種類」を定義します。
- APIのパス名として使用される
- 同じエンドポイント内のコンテンツは同じ構造を持つ
例
| エンドポイント | パス名 | 用途 |
|---|---|---|
| ニュース | news | お知らせ記事 |
| ブログ | blog | ブログ記事 |
| 製品情報 | products | 製品紹介 |
コンテンツ
コンテンツは実際の記事やデータです。
- 必ず1つのエンドポイントに属する
- タイトルと本文(リッチテキスト)を持つ
- 複数のカテゴリを付与可能
- ステータス(下書き/公開)で公開状態を管理
ステータス
| ステータス | 説明 | APIから取得 |
|---|---|---|
| 下書き(Draft) | 編集中の状態 | 不可 |
| 公開(Published) | 公開済みの状態 | 可能 |
カテゴリ
カテゴリはコンテンツを分類するためのタグです。
- サービス単位で定義
- 1つのコンテンツに複数のカテゴリを付与可能
- エンドポイントを横断して使用可能
例
- 「重要」カテゴリ
- 「イベント」カテゴリ
- 「プレスリリース」カテゴリ
データ構造の関係
サービス
├── エンドポイント A
│ ├── コンテンツ 1 [カテゴリX, カテゴリY]
│ ├── コンテンツ 2 [カテゴリX]
│ └── コンテンツ 3
├── エンドポイント B
│ ├── コンテンツ 4 [カテゴリY]
│ └── コンテンツ 5
├── カテゴリ X
├── カテゴリ Y
└── メンバー(ユーザーと権限)