diff --git a/packages/microcms-api-schema-schema/README.md b/packages/microcms-api-schema-schema/README.md index 0842789..fc14e4b 100644 --- a/packages/microcms-api-schema-schema/README.md +++ b/packages/microcms-api-schema-schema/README.md @@ -9,9 +9,67 @@ microCMS の API スキーマを定義するためのスキーマライブラリ ## インストール ```bash -pnpm add microcms-api-schema-schema +npm install -D @plainbrew/microcms-api-schema-schema +pnpm add -D @plainbrew/microcms-api-schema-schema ``` +## 使い方 + +### JSON Schema としての利用 + +`$schema` プロパティで JSON Schema を参照することで、エディタの補完やバリデーションを有効にできます。 + +```json +{ + "$schema": "./node_modules/@plainbrew/microcms-api-schema-schema/schema.json", + "apiFields": [ + { + "fieldId": "title", + "name": "タイトル", + "kind": "text", + "required": true + }, + { + "fieldId": "body", + "name": "本文", + "kind": "richEditorV2", + "required": false + }, + { + "fieldId": "thumbnail", + "name": "サムネイル", + "kind": "media", + "required": true, + "imageSizeValidation": { + "imageSize": { + "width": 1200, + "height": 630 + } + } + } + ], + "customFields": [] +} +``` + +### サポートされるフィールドタイプ + +| kind | 説明 | +| -------------- | ------------------ | +| `text` | テキストフィールド | +| `textArea` | テキストエリア | +| `richEditorV2` | リッチエディタ | +| `richEditor` | 旧リッチエディタ | +| `media` | 画像 | +| `mediaList` | 複数画像 | +| `date` | 日時 | +| `boolean` | 真偽値 | +| `select` | セレクトフィールド | +| `number` | 数字 | +| `relation` | コンテンツ参照 | +| `relationList` | 複数コンテンツ参照 | +| `iframe` | 拡張フィールド | + ## 開発 ```bash diff --git a/packages/microcms-api-schema-schema/package.json b/packages/microcms-api-schema-schema/package.json index 103c397..49bd5bd 100644 --- a/packages/microcms-api-schema-schema/package.json +++ b/packages/microcms-api-schema-schema/package.json @@ -1,6 +1,6 @@ { "name": "@plainbrew/microcms-api-schema-schema", - "version": "0.0.1-alpha.0", + "version": "0.0.1", "description": "", "license": "MIT", "files": [