Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
Mutation GraphQLExécuter une mutation GraphQL sur un endpoint
Requête GraphQLExécuter une requête GraphQL sur un endpoint

Modules

Mutation GraphQL

graphql.mutation

Exécuter une mutation GraphQL sur un endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL du point de terminaison GraphQL
mutationstringYes-Chaîne de mutation GraphQL
variablesobjectNo-Variables de mutation GraphQL sous forme de paires clé-valeur
headersobjectNo-En-têtes HTTP supplémentaires à envoyer avec la requête
auth_tokenstringNo-Jeton Bearer pour l'authentification (ajouté comme en-tête Authorization)

Output:

FieldTypeDescription
dataobjectDonnées de réponse GraphQL
errorsarrayErreurs GraphQL (null s'il n'y a pas d'erreurs)
status_codenumberCode de statut 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"}}

Requête GraphQL

graphql.query

Exécuter une requête GraphQL sur un endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL du point de terminaison GraphQL
querystringYes-Chaîne de requête GraphQL
variablesobjectNo-Variables de requête GraphQL sous forme de paires clé-valeur
headersobjectNo-En-têtes HTTP supplémentaires à envoyer avec la requête
auth_tokenstringNo-Jeton Bearer pour l'authentification (ajouté comme en-tête Authorization)

Output:

FieldTypeDescription
dataobjectDonnées de réponse GraphQL
errorsarrayErreurs GraphQL (null s'il n'y a pas d'erreurs)
status_codenumberCode de statut 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.