GraphQL の構成ファイル

Atlas App Services はサポート終了のステータスに達し、 MongoDBでアクティブにサポートされなくなりました。Atlas UIでは引き続き trigger を利用できます。詳細については、の廃止ページを参照してください。

注意

このページでは、レガシー構成ファイル形式について説明します。非推奨の realm-cliを使用している場合にのみ、この情報を使用する必要があります。

App Services CLI を使用してプルする構成ファイル、または UI からエクスポートする構成ファイルには、最新の構成バージョンが使用されます。現在の構成ファイル形式の詳細については、「アプリ構成」を参照してください。

アプリケーション用のGraphQL APIはgraphqlディレクトリで構成できます。

app/
└── graphql/
    ├── config.json
    └── custom_resolvers
        └── <resolver name>.json

サービス構成

graphql/config.json

{
  "use_natural_pluralization": <Boolean>,
  "disable_schema_introspection": <Boolean>
}

フィールド

説明

use_natural_pluralization

Boolean

true 新しいアプリの場合はデフォルトで。

この値をfalseに設定できるのは、が Admin API エンドポイントを使用して新しいアプリを作成し、プロパティをリクエストの本文に渡す場合のみです。アプリが作成されると、この値はfalseに変更できません。

true の場合、生成されたスキーマ型名では、可能な限り一般的な英語の複数形が使用されます。

false の場合、または自然な複数形を決定できない場合、複数形の型では、末尾に "s" が追加された単数形の型名が使用されます。

例

App Services では、生成された "mous" 型に対して自然な複数形またはデフォルトの複数形のいずれかを使用できます。

自然: "mlice"
デフォルト: "mouss"

disable_schema_introspection

Boolean

この値は、新しいアプリのデフォルトではfalseです。

trueの場合、 GraphQL API はクライアントからのイントロスペクションクエリをブロックします。

この設定は、GraphQL スキーマを一般に公開したくない本番アプリに役立ちます。イントロスペクションが無効になっている場合、GraphQLDocs などのクライアントはAPI スキーマのを表示したり、クエリやミューテーションをオートコンプリートしたりすることはできません。

カスタムリゾルバ構成

GraphQL/custom_resolvers/"resolver<resolver name> name".json

{
  "on_type": "<Parent Type Name>",
  "field_name": "<Resolver Field Name>",
  "function_name": "<Resolver Function Name>",
  "input_type": "<Input Type Name>" | { <JSON Schema> },
  "input_type_format": "<Input Type Format>",
  "payload_type": "<Payload Type Name>" | { <JSON Schema> },
  "payload_type_format": "<Payload Type Format>",
}

フィールド

説明

on_type

String

カスタムリゾルバをフィールドの 1 つとして公開する親型。

有効なオプション:

"Query" （カスタムクエリ操作用）
"Mutation" （カスタムミューテーション操作用）
単数形の公開型名（計算プロパティ用）

field_name

String

カスタムリゾルバを公開する親型のフィールドの名前。フィールド名は、その親型のすべてのカスタムリゾルバ間で一意である必要があります。

フィールド名が親型のスキーマ内のフィールドと一致する場合、カスタムリゾルバはそのスキーマ型を上書きします。

function_name

String

リゾルバが呼び出されるときに実行される関数の名前。関数引数は、単一の引数（ input_typeとinput_type_formatで構成）を受け入れることができ、ペイロード値（ payload_typeとpayload_type_formatで構成）を返す必要があります。

input_type

String | JSON Schema

リゾルバのinput引数の型（入力を受け入れる場合）。 GraphQLスキーマ内の別のタイプの名前または、リゾルバに固有のカスタムJSON schemaの名前を指定できます。

input_type_format

String

input_typeのメタデータの説明。

有効なオプション:

"scalar" （特定の BSON type の単一の値用）
"scalar-list" （特定の BSON type の複数の値用）
"generated" （特定の公開タイプの単一の値の場合）
"generated-list" （特定の公開タイプの複数の値用）
"custom" （カスタム JSON schema の場合）

payload_type

String | JSON Schema

リゾルバのペイロードで返される値の型。 GraphQLスキーマ内の別のタイプの名前または、リゾルバに固有のカスタムJSON schemaの名前を指定できます。

ペイロード型を指定しない場合、リゾルバはDefaultPayloadオブジェクトを返します。

type DefaultPayload {
  status: String!
}

payload_type_format

String

payload_typeのメタデータの説明。

有効なオプション:

"scalar" （特定の BSON type の単一の値用）
"scalar-list" （特定の BSON type の複数の値用）
"generated" （特定の公開タイプの単一の値の場合）
"generated-list" （特定の公開タイプの複数の値用）
"custom" （カスタム JSON schema の場合）

Atlas アプリケーションサービスとは

注意

サービス構成

例

カスタム リゾルバ構成

カスタムリゾルバ構成