Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
GraphQL-MutationFühren Sie eine GraphQL-Mutation gegen einen Endpunkt aus
GraphQL-AbfrageFühren Sie eine GraphQL-Abfrage gegen einen Endpunkt aus

Modules

GraphQL-Mutation

graphql.mutation

Führen Sie eine GraphQL-Mutation gegen einen Endpunkt aus

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-GraphQL-Endpunkt-URL
mutationstringYes-GraphQL-Mutationszeichenfolge
variablesobjectNo-GraphQL-Mutationsvariablen als Schlüssel-Wert-Paare
headersobjectNo-Zusätzliche HTTP-Header, die mit der Anfrage gesendet werden
auth_tokenstringNo-Bearer-Token zur Authentifizierung (als Authorization-Header hinzugefügt)

Output:

FieldTypeDescription
dataobjectGraphQL-Antwortdaten
errorsarrayGraphQL-Fehler (null, wenn keine Fehler)
status_codenumberHTTP-Statuscode

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"}}

GraphQL-Abfrage

graphql.query

Führen Sie eine GraphQL-Abfrage gegen einen Endpunkt aus

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-GraphQL-Endpunkt-URL
querystringYes-GraphQL-Abfragezeichenfolge
variablesobjectNo-GraphQL-Abfragevariablen als Schlüssel-Wert-Paare
headersobjectNo-Zusätzliche HTTP-Header, die mit der Anfrage gesendet werden
auth_tokenstringNo-Bearer-Token zur Authentifizierung (als Authorization-Header hinzugefügt)

Output:

FieldTypeDescription
dataobjectGraphQL-Antwortdaten
errorsarrayGraphQL-Fehler (null, wenn keine Fehler)
status_codenumberHTTP-Statuscode

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.