Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
Mutación GraphQLEjecuta una mutación GraphQL en un endpoint
Consulta GraphQLEjecuta una consulta GraphQL en un endpoint

Modules

Mutación GraphQL

graphql.mutation

Ejecuta una mutación GraphQL en un endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL del endpoint GraphQL
mutationstringYes-Cadena de mutación GraphQL
variablesobjectNo-Variables de mutación GraphQL como pares clave-valor
headersobjectNo-Encabezados HTTP adicionales para enviar con la solicitud
auth_tokenstringNo-Token Bearer para autenticación (añadido como encabezado de Autorización)

Output:

FieldTypeDescription
dataobjectDatos de respuesta de GraphQL
errorsarrayErrores de GraphQL (nulo si no hay errores)
status_codenumberCódigo de estado 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

Ejecuta una consulta GraphQL en un endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL del endpoint GraphQL
querystringYes-Cadena de consulta GraphQL
variablesobjectNo-Variables de consulta GraphQL como pares clave-valor
headersobjectNo-Encabezados HTTP adicionales para enviar con la solicitud
auth_tokenstringNo-Token Bearer para autenticación (añadido como encabezado de Autorización)

Output:

FieldTypeDescription
dataobjectDatos de respuesta de GraphQL
errorsarrayErrores de GraphQL (nulo si no hay errores)
status_codenumberCódigo de estado 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.