Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
Mutação GraphQLExecutar uma mutação GraphQL em um endpoint
Consulta GraphQLExecutar uma consulta GraphQL em um endpoint

Modules

Mutação GraphQL

graphql.mutation

Executar uma mutação GraphQL em um endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL do endpoint GraphQL
mutationstringYes-String de mutação GraphQL
variablesobjectNo-Variáveis da mutação GraphQL como pares chave-valor
headersobjectNo-Cabeçalhos HTTP adicionais para enviar com a solicitação
auth_tokenstringNo-Token Bearer para autenticação (adicionado como cabeçalho de autorização)

Output:

FieldTypeDescription
dataobjectDados de resposta do GraphQL
errorsarrayErros do GraphQL (nulo se não houver erros)
status_codenumberCódigo de status HTTP

Example: Create user mutation

yaml
url: https://api.example.com/graphql
mutation: mutation CreateUser($input: UserInput!) { createUser(input: $input) { id name } }
variables: {"input": {"name": "John", "email": "john@example.com"}}

Consulta GraphQL

graphql.query

Executar uma consulta GraphQL em um endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL do endpoint GraphQL
querystringYes-String de consulta GraphQL
variablesobjectNo-Variáveis da consulta GraphQL como pares chave-valor
headersobjectNo-Cabeçalhos HTTP adicionais para enviar com a solicitação
auth_tokenstringNo-Token Bearer para autenticação (adicionado como cabeçalho de autorização)

Output:

FieldTypeDescription
dataobjectDados de resposta do GraphQL
errorsarrayErros do GraphQL (nulo se não houver erros)
status_codenumberCódigo de status HTTP

Example: Simple query

yaml
url: https://api.example.com/graphql
query: { users { id name } }

Example: Query with variables and auth

yaml
url: https://api.example.com/graphql
query: query GetUser($id: ID!) { user(id: $id) { id name email } }
variables: {"id": "123"}
auth_token: my-token

Released under the Apache 2.0 License.