GraphQL スキーマ ビューとスキーマ エクスプローラー用の Fabric API

GraphQL スキーマは、GraphQL スキーマ定義言語 (SDL) に基づいて、API で公開されるデータの形式を定義します。 これは、バックエンド実装の詳細を非表示にしながら、コンシューマーに柔軟性を提供する抽象化レイヤーです。 スキーマは、フィールドを含むオブジェクト型のコレクションに基づいています。

スキーマ ビュー

スキーマ ビューにアクセスするには、[データ開発] 画面の左下隅にある [スキーマ] を選択します。 このビューには、生成された型、フィールド、および操作を含む GraphQL SDL のテキストベースのバージョンが表示されます。

次の図は、このスキーマで使用できるオブジェクトの広範な一覧を含むスキーマ ビューの例です。

スキーマ エクスプローラー

[スキーマ エクスプローラー]は左側のウィンドウにあり、クエリ ビューでエディターを使用する場合にも利用できます。 エクスプローラーを使用すると、使用可能な型とフィールド、および API で定義されているクエリや変更をすばやく視覚化できます。

データ ソースに接続するときに選択したオブジェクトから使用できるすべての GraphQL の種類が、スキーマ エクスプローラーの一覧に表示されます。 型は、派生元のデータ ソースの名前の下に表示されます。 次の図では、AdventureWorks SQL 分析エンドポイントの SalesOrderDetail テーブルから派生した SalesOrderDetail 型が表示されています。

型に加えて、GraphQL 用の Fabric API では、公開する新しいオブジェクトのクエリと変更が自動的に生成されます。

AdventureWorks の例では、クエリの一覧を展開すると、データ ソースに対して自動的に生成されるクエリが表示されます。

API によって自動的に生成された変更を確認するには、スキーマ エクスプローラー ツリーで変更ノードを展開します。

スキーマ エクスプローラーを使用してオブジェクトを変更する

スキーマ エクスプローラーを使用して、API でオブジェクトを作成した後でオブジェクトを変更できます。 次の例では、AdventureWorks データベースから派生した SalesOrderDetail 型の横にある省略記号を選択します。

TYPE では次のオプションを選択できます。

• [スキーマの更新] - データ ソースの新しいオブジェクトでスキーマを更新できます。
• [名前の変更] - オブジェクトの名前を変更します。 注: この変更は API スキーマにのみ影響し、派生元の元のデータ ソース オブジェクトには影響しません。
• [スキーマから削除] - GraphQL スキーマからオブジェクトを効果的に削除して、オブジェクトを参照できないようにします。
• [リレーションシップの管理] - リレーションシップ管理エクスペリエンスに移動します。 詳細については、「GraphQL 用 Fabric API でのリレーションシップの管理」を参照してください。
• [プロパティ] - オブジェクトに関する追加情報を表示します。

クエリと変更を有効または無効にする

クエリと変更の有効化/無効化機能により、管理者と開発者は API のアクセスと使用状況をきめ細かく制御できます。 GraphQL スキーマ内の特定のクエリと変更を選択的にアクティブ化または非アクティブ化できます。 これにより、コードを変更したり、変更をデプロイしたりすることなく、API 機能を動的に管理できます。

スキーマ エクスプローラーのクエリと変更には、次の 2 つの追加オプションがあります。

• 無効 - すべての要求でクエリまたは変更が実行されないようにします。 実行が試行されると、エラーが返されます。 クエリまたは変更が無効になると、スキーマの再読み込みが行われ、クエリまたは変更がスキーマ エクスプローラーで淡色表示されます。

• 有効 - 以前に無効にしたクエリまたは変更を再度有効にします。 項目の実行は、[有効化] オプションを選択した後に実行されるスキーマの再読み込み操作の直後に使用できます。

ストアド プロシージャから自動生成されたクエリまたは変更は、削除することしかできないことに注意してください。 削除したら、[データの取得] または [スキーマの更新] オプションを使用して再追加できます。

関連するコンテンツ

• GraphQL エディター用のファブリック API