Definir um Resolvedor Personalizado

Criar um novo revendedor personalizado

Na UI do App Services, clique em GraphQL na barra lateral de navegação e selecione a aba Custom Resolvers.

Clique no botão Add a Custom Resolver para abrir a tela de configuração de um novo resolvedor personalizado.

Definir o Nome do Campo do Resolvedor

Especifique o nome do App Services para o resolvedor na entrada GraphQL Field Name. O App Services expõe o resolvedor personalizado em seu tipo principal usando esse nome, portanto, o nome deve descrever o que o resolvedor faz de uma forma que seja útil para desenvolvedores que trabalham com GraphQL API.

Definir o tipo principal

O App Services expõem cada resolvedor personalizado como um campo em um tipo principal. O tipo principal pode ser uma query em nível raiz, uma mutação ou um tipo de documento gerado.

No menu suspenso Parent Type, selecione uma das seguintes opções:

type Query {
  myCustomQuery: DefaultPayload
  ...
}

type Mutation {
  myCustomMutation: DefaultPayload
  ...
}

type Task {
  myCustomTaskProperty: DefaultPayload
  ...
}

Definir o Tipo de Entrada

Um resolvedor personalizado pode aceitar parâmetros de entrada da query ou mutação recebida. Você pode usar um tipo de entrada gerado existente ou definir um novo tipo de entrada personalizado especificamente para o resolvedor.

Se você especificar um tipo de entrada, o App Services expõe o parâmetro input na definição do esquema GraphQL gerado pelo resolvedor personalizado como um parâmetro opcional que aceita o tipo de entrada especificado. Se você não especificar um tipo de entrada, o resolvedor personalizado não aceitará nenhum argumento.

No menu suspenso Input Type, selecione uma das seguintes opções:

Opção	Descrição
None	O resolvedor não aceita nenhuma entrada. Exemplo Um resolvedor personalizado denominado myCustomQuery que não aceita uma entrada tem o seguinte esquema gerado: type Query { myCustomQuery: DefaultPayload ... }
Scalar	O resolvedor usa um tipo escalar existente do esquema GraphQL gerado. Na segunda entrada suspensa, selecione um único escalar ou uma array de múltiplos escalares do mesmo tipo. Exemplo Um resolvedor personalizado denominado myCustomQuery que utiliza a opção Scalar Type para especificar um tipo de entrada de DateTiem tem o seguinte esquema gerado: type Query { myCustomQuery(input: DateTime): DefaultPayload ... }
Existing Type	O resolvedor usa um tipo de entrada existente do esquema GraphQL gerado. Na segunda entrada suspensa, selecione um único objeto de entrada ou uma array de vários objetos de entrada do mesmo tipo. Exemplo Um resolvedor personalizado denominado myCustomQuery que utiliza a opção Existing Type para especificar um tipo de entrada de TaskInsertInput tem o seguinte esquema gerado: type Query { myCustomQuery(input: TaskInsertInput): DefaultPayload ... }
Custom Type	O App Services gera um novo tipo de entrada especificamente para o resolvedor com base em um esquema definido por você. O esquema deve ser um object que contém pelo menos uma propriedade e um campo title que define um nome único para o tipo de entrada gerado. Exemplo Um resolvedor personalizado denominado myCustomQuery que utiliza a opção Custom Type com um tipo de entrada denominado MyCustomQueryInput tem o seguinte esquema gerado: input MyCustomQueryInput { someArgument: String; } type Query { myCustomQuery(input: MyCustomQueryInput): DefaultPayload ... }

Definir o tipo de carga útil

Todos os resolvedores GraphQL devem retornar uma carga útil que esteja em conformidade com um tipo específico no esquema. Para um resolvedor personalizado, você pode usar um tipo de documento gerado existente, definir um novo tipo de carga útil personalizada especificamente para o resolvedor ou usar uma carga útil padrão. O App Services inclui o tipo de carga útil especificado na definição do esquema GraphQL gerada pelo resolvedor personalizado.

No menu suspenso Payload Type, selecione uma das seguintes opções:

Opção	Descrição
DefaultPayload	O resolvedor retorna o tipo de DefaultPayload gerado automaticamente que tem a seguinte assinatura: type DefaultPayload { status: String! } O campo status sempre será resolvido como "complete", independente do valor de retorno da função de resolução. { status: "complete" } Exemplo Um resolvedor personalizado denominado myCustomQuery que utiliza a opção DefaultPayload tem o seguinte esquema gerado: type Query { myCustomQuery: DefaultPayload ... }
Scalar	O resolvedor usa um tipo escalar existente do esquema GraphQL gerado. Na segunda entrada suspensa, selecione um único escalar ou uma array de múltiplos escalares do mesmo tipo. Exemplo Um resolvedor personalizado denominado myCustomQuery que usa a opção Scalar Type para especificar um tipo de carga útil do DateTime tem o seguinte esquema gerado: type Query { myCustomQuery: DateTime ... }
Existing Type	O resolvedor retorna um tipo de documento existente do esquema GraphQL gerado. Na segunda entrada suspensa, selecione um único tipo de documento ou uma array de vários documentos do mesmo tipo. Exemplo Um resolvedor personalizado denominado myCustomQuery que utiliza a opção Existing Type para especificar um tipo de entrada de TaskInsertInput tem o seguinte esquema gerado: Um resolvedor personalizado denominado myCustomQuery que usa a opção Existing Type para especificar um tipo de carga útil do [Task] tem o seguinte esquema gerado: type Query { myCustomQuery: [Task] ... }
Custom Type	O App Services gera um novo tipo de carga útil especificamente para o resolvedor com base em um esquema definido por você. O esquema deve ser um object que contém pelo menos uma propriedade e um campo title que define um nome único para o tipo de entrada gerado. Exemplo Um resolvedor personalizado denominado myCustomQuery que usa a opção Custom Type com um tipo de carga útil denominado MyCustomQueryPayload tem o seguinte esquema gerado: input MyCustomQueryPayload { someValue: String; } type Query { myCustomQuery: MyCustomQueryPayload ... }

Definir a função Resolver

Quando um usuário chama um resolvedor personalizado, o App Services executa a função do resolvedor e retorna o resultado, que deve estar em conformidade com o Payload Type do resolvedor.

O App Services transmite à função todos os dados de entrada da operação, se aplicável. Se o resolvedor for uma propriedade calculada em um tipo de documento, o App Services transmitirá à função o documento específico em que o resolvedor foi chamado.

Uma função de resolução personalizada tem uma de duas assinaturas possíveis, dependendo se ela aceita ou não uma entrada:

Para definir a função do resolvedor, clique no menu suspenso Function e selecione uma função existente, ou crie uma nova.

Salvar e distribuir o resolvedor

Após configurar o resolvedor, clique em Save e distribua seu aplicativo. Depois de distribuído, você pode chamar o resolvedor personalizado por meio do GraphQL API.