スキーマ設定の作成

スキーマ設定は、カスタムエンドポイントおよびパーシステッドクエリのスキーマをカスタマイズするために使用されます。

GraphQL スキーマは、インストールされて有効化されたさまざまなモジュールが提供する要素を使って設定できます。（すべてのモジュールの一覧はモジュールページでご確認ください。）

各モジュールは、スキーマ設定エディター内の専用ブロックを通じて設定を定義できます。これには以下のようなブロックが含まれます：

• スキーマをパブリックまたはプライベートとして設定する
• 「センシティブ」なデータ要素を有効化する
• スキーマに名前空間を適用する
• ネストされたミューテーションを使用する
• レスポンスヘッダーを定義する
• アクセスコントロールリストを使ってスキーマへのアクセス権を定義する
• キャッシュコントロールリストを使って HTTP キャッシュを設定する
• その他多数

​

すべてのスキーマ設定へのアクセス

プラグインのメニューにある「Schema Configurations」をクリックすると、一覧が表示されます：

​

新しいスキーマ設定の作成

「Add New Schema Configuration」ボタンをクリックして WordPress エディターを開きます：

​

「Default」値の設定を使用するブロックの削除（オプション）

設定から対応する「Default」値を使用している設定ブロックを削除することができます。

削除したブロックは、下部にある + ボタンをクリックしてインサーターメニューから再度追加できます（各ブロックのインスタンスは1つのみ挿入可能です）：

その後、必要なブロックの設定を行います。

​

スキーマ設定の説明

ドキュメント設定パネルにある「Excerpt」フィールドを使用して、スキーマ設定に説明を付けます。

詳しくは、ガイド API への説明の追加をご参照ください。

​

スキーマ設定の公開

スキーマ設定に必要な要素を選択してオプションを調整します。準備ができたら「Publish」をクリックします：

​

スキーマ設定の使用

公開後、スキーマ設定はカスタムエンドポイントおよびパーシステッドクエリのエディターで利用できるようになります：

​

スキーマ設定の表示

ブラウザでスキーマ設定のパーマリンクを開くと、その内容が表示されます（ユーザーがログインしており、ユーザーロールがアクセス権を持っている場合）：