Definir un solucionador personalizado

Crear un nuevo solucionador personalizado

En la interfaz de usuario de App Services, haga clic en GraphQL en la barra lateral de navegación y luego seleccione la pestaña Custom Resolvers.

Haga clic en el botón Add a Custom Resolver para abrir la pantalla de configuración de un nuevo solucionador personalizado.

Definir el nombre del campo de resolución

Especifique el nombre de App Services para el solucionador en la entrada GraphQL Field Name. App Services expone el solucionador personalizado en su tipo principal con este nombre, por lo que este debe describir la función del solucionador de forma útil para los desarrolladores que trabajan con la API GraphQL.

Definir el tipo de padre

App Services expone cada solucionador personalizado como un campo de un tipo principal. Este tipo principal puede ser unaconsulta de nivel raíz, una mutación o un tipo de documento generado.

En el menú desplegable Parent Type, seleccione una de las siguientes opciones:

type Query {
  myCustomQuery: DefaultPayload
  ...
}

type Mutation {
  myCustomMutation: DefaultPayload
  ...
}

type Task {
  myCustomTaskProperty: DefaultPayload
  ...
}

Definir el tipo de entrada

Un resolvedor personalizado puede aceptar parámetros de entrada de la consulta o mutación entrante. Puede usar un tipo de entrada generado previamente o definir uno nuevo específicamente para el resolvedor.

Si especifica un tipo de entrada, App Services expone el parámetro input en la definición del esquema GraphQL generada por el solucionador personalizado como un parámetro opcional que acepta el tipo de entrada especificado. Si no especifica un tipo de entrada, el solucionador personalizado no acepta ningún argumento.

En el menú desplegable Input Type, seleccione una de las siguientes opciones:

Opción	Descripción
None	El resolver no acepta ninguna entrada. Ejemplo Un solucionador personalizado llamado myCustomQuery que no acepta una entrada tiene el siguiente esquema generado: type Query { myCustomQuery: DefaultPayload ... }
Scalar	El solucionador utiliza un tipo escalar existente del esquema GraphQL generado. En el segundo campo desplegable, elige un único escalar o un arreglo de múltiples escalares del mismo tipo. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Scalar Type para especificar un tipo de entrada de DateTiem tiene el siguiente esquema generado: type Query { myCustomQuery(input: DateTime): DefaultPayload ... }
Existing Type	El solucionador utiliza un tipo de entrada existente del esquema GraphQL generado. En la segunda entrada desplegable, seleccione un solo objeto de entrada o una matriz de múltiples objetos de entrada del mismo tipo. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Existing Type para especificar un tipo de entrada de TaskInsertInput tiene el siguiente esquema generado: type Query { myCustomQuery(input: TaskInsertInput): DefaultPayload ... }
Custom Type	App Services genera un nuevo tipo de entrada específicamente para el solucionador, basándose en un esquema definido por el usuario. El esquema debe ser un object que contenga al menos una propiedad y un title campo que defina un nombre único para el tipo de entrada generado. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Custom Type con un tipo de entrada llamado MyCustomQueryInput tiene el siguiente esquema generado: input MyCustomQueryInput { someArgument: String; } type Query { myCustomQuery(input: MyCustomQueryInput): DefaultPayload ... }

Definir el tipo de carga útil

Todos los resolvedores GraphQL deben devolver una carga útil que se ajuste a un tipo específico del esquema. Para un resolvedor personalizado, puede usar un tipo de documento generado previamente, definir un nuevo tipo de carga útil personalizado específicamente para el resolvedor o usar una carga útil predeterminada. App Services incluye el tipo de carga útil especificado en la definición del esquema GraphQL generada por el resolvedor personalizado.

En el menú desplegable Payload Type, seleccione una de las siguientes opciones:

Opción	Descripción
DefaultPayload	El solucionador devuelve el tipo DefaultPayload generado automáticamente que tiene la siguiente firma: type DefaultPayload { status: String! } El campo status siempre se resolverá en "complete" independientemente del valor de retorno de la función de resolución. { status: "complete" } Ejemplo Un solucionador personalizado llamado myCustomQuery que utiliza la opción DefaultPayload tiene el siguiente esquema generado: type Query { myCustomQuery: DefaultPayload ... }
Scalar	El solucionador utiliza un tipo escalar existente del esquema GraphQL generado. En el segundo campo desplegable, elige un único escalar o un arreglo de múltiples escalares del mismo tipo. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Scalar Type para especificar un tipo de carga útil de DateTime tiene el siguiente esquema generado: type Query { myCustomQuery: DateTime ... }
Existing Type	El solucionador devuelve un tipo de documento existente del esquema GraphQL generado. En la segunda entrada desplegable, seleccione un solo tipo de documento o una matriz de varios documentos del mismo tipo. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Existing Type para especificar un tipo de entrada de TaskInsertInput tiene el siguiente esquema generado: Un solucionador personalizado llamado myCustomQuery que usa la opción Existing Type para especificar un tipo de carga útil de [Task] tiene el siguiente esquema generado: type Query { myCustomQuery: [Task] ... }
Custom Type	App Services genera un nuevo tipo de payload específicamente para el resolver según un esquema que tú defines. El esquema debe ser un object que contenga al menos una propiedad y un campo title que defina un nombre único para el tipo de entrada generado. Ejemplo Un solucionador personalizado llamado myCustomQuery que usa la opción Custom Type con un tipo de carga útil llamado MyCustomQueryPayload tiene el siguiente esquema generado: input MyCustomQueryPayload { someValue: String; } type Query { myCustomQuery: MyCustomQueryPayload ... }

Definir la función de resolución

Cuando un usuario llama a un resolvedor personalizado, App Services ejecuta la función resolvedora y devuelve el resultado, que debe cumplir con el Payload Type del resolvedor.

App Services pasa a la función cualquier dato de entrada de la operación, si corresponde. Si el resolvedor es una propiedad calculada de un tipo de documento, App Services pasa a la función el documento específico en el que se invocó.

Una función de resolución personalizada tiene una de dos firmas posibles, dependiendo de si acepta o no una entrada:

exports = function myCustomResolver(input, source) {
  // The `input` parameter that contains any input data provided to the resolver.
  // The type and shape of this object matches the resolver's input type.
  const { someArgument } = input;
  // If the resolver is a computed property, `source` is the parent document.
  // Otherwise `source` is undefined.
  const { _id, name } = source;
  // The return value must conform to the resolver's configured payload type
  return {
    "someValue": "abc123",
  };
}

exports = function myCustomResolver(source) {
  // If the resolver is a computed property, `source` is the parent document.
  // Otherwise `source` is undefined.
  const { _id, name } = parent;
  // The return value must conform to the resolver's configured payload type
  return {
    "someValue": "abc123",
  };
}

Para definir la función de resolución, haga clic en el menú desplegable Function y seleccione una función existente o cree una nueva.

Guardar e implementar el solucionador

Una vez configurado el resolver, haga clic en Save e implemente su aplicación. Una vez implementada, puede llamar al resolver personalizado a través de la API de GraphQL.