GraphQL Configuration Files

Atlas App Services ha alcanzado su estado de fin de vida útil y ya no recibe soporte activo por parte de MongoDB. Los activadores siguen disponibles en la Interfaz de Usuario de Atlas. Remítase a deprecation page for details.

Nota

Esta página describe un formato de archivo de configuración heredado. Solo debe usar esta información si está usando el formato obsoleto. realm-cli.

Cualquier archivo de configuración que extraiga con la CLI de App Services o exporte desde la interfaz de usuario utiliza la versión más reciente. Para obtener información detallada sobre el formato actual de los archivos de configuración, consulte Configuración de la aplicación.

Puede configurar la API GraphQL para su aplicación en el graphql directorio:

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

Configuración del Servicio

graphql/config.json

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

Campo

Descripción

use_natural_pluralization

Boolean

true por defecto para nuevas aplicaciones.

Solo puedes establecer el valor en false cuando Cree una nueva aplicación con el punto final de la API de administración y pase la propiedad al cuerpo de la solicitud. El valor no se puede cambiar a false una vez creada la aplicación.

If true, generated schema type names use common English pluralization whenever possible.

Si false, o si no se puede determinar una pluralización natural, entonces los tipos plurales usan el nombre del tipo singular con una "s" añadida al final.

Ejemplo

App Services can use either a natural plural or a default plural for a generated "mouse" type:

Natural: "ratones"
Predeterminado: "ratones"

disable_schema_introspection

Boolean

Este valor es false por defecto para las nuevas aplicaciones.

trueSi, la API GraphQL bloquea las consultas de introspección de los clientes.

Esta configuración es útil para aplicaciones de producción que no desean exponer su esquema GraphQL al público. Cuando la introspección está deshabilitada, clientes como GraphiQL no pueden mostrar la documentación del esquema de la API ni autocompletar consultas y mutaciones.

Configuración de resolvedor personalizada

graphql/custom_resolvers/.json<resolver name>

{
  "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>",
}

Campo

Descripción

on_type

String

El tipo principal que expone el solucionador personalizado como uno de sus campos.

Opciones válidas:

"Query" (para custom query operaciones)
"Mutation" (para operaciones de mutación personalizadas)
Un nombre singular de tipo expuesto (para propiedades calculadas)

field_name

String

El nombre del campo en el tipo padre que expone el resolver personalizado. El nombre del campo debe ser único entre todos los resolutores personalizados en su tipo padre.

If the field name matches a field in the parent type's schema, the custom resolver overrides the schema type.

function_name

String

The name of the function that runs when the resolver is called. The function arguments may accept a single argument (configured by input_type and input_type_format) and must return a payload value (configured by payload_type and payload_type_format).

input_type

String | JSON Schema

El tipo del argumento input del resolvedor (si acepta entrada). Puede especificar el nombre de otro tipo en su esquema GraphQL o un esquema JSON personalizado específico del resolvedor.

input_type_format

String

Una descripción de metadatos de input_type.

Opciones válidas:

"scalar" (para un valor único de un tipo BSON específico)
"scalar-list" (para múltiples valores de un tipo específico de BSON)
"generated" (for a single value of a specific exposed type)
"generated-list" (for multiple values of a specific exposed type)
"custom" (para un esquema JSON personalizado)

payload_type

String | JSON Schema

The type of the value returned in the resolver's payload. You can specify either the name of another type in your GraphQL schema or a custom JSON schema specific to the resolver.

If you do not specify a payload type, the resolver returns a DefaultPayload object:

type DefaultPayload {
  status: String!
}

payload_type_format

String

Una descripción de metadatos de payload_type.

Opciones válidas:

"scalar" (para un valor único de un tipo BSON específico)
"scalar-list" (para múltiples valores de un tipo específico de BSON)
"generated" (for a single value of a specific exposed type)
"generated-list" (for multiple values of a specific exposed type)
"custom" (para un esquema JSON personalizado)

¿Qué son los servicios de aplicación Atlas?