Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
GraphQL ミューテーションエンドポイントに対してGraphQLミューテーションを実行
GraphQL クエリエンドポイントに対してGraphQLクエリを実行

Modules

GraphQL ミューテーション

graphql.mutation

エンドポイントに対してGraphQLミューテーションを実行

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-GraphQLエンドポイントのURL
mutationstringYes-GraphQLミューテーション文字列
variablesobjectNo-キーと値のペアとしてのGraphQLミューテーション変数
headersobjectNo-リクエストと共に送信する追加のHTTPヘッダー
auth_tokenstringNo-認証用のベアラートークン(Authorizationヘッダーとして追加)

Output:

FieldTypeDescription
dataobjectGraphQLレスポンスデータ
errorsarrayGraphQLエラー(エラーがない場合はnull)
status_codenumberHTTPステータスコード

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 クエリ

graphql.query

エンドポイントに対してGraphQLクエリを実行

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-GraphQLエンドポイントのURL
querystringYes-GraphQLクエリ文字列
variablesobjectNo-キーと値のペアとしてのGraphQLクエリ変数
headersobjectNo-リクエストと共に送信する追加のHTTPヘッダー
auth_tokenstringNo-認証用のベアラートークン(Authorizationヘッダーとして追加)

Output:

FieldTypeDescription
dataobjectGraphQLレスポンスデータ
errorsarrayGraphQLエラー(エラーがない場合はnull)
status_codenumberHTTPステータスコード

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.