Skip to content

GraphQL

Execute GraphQL queries and mutations.

2 modules

ModuleDescription
GraphQL Mutationดำเนินการ GraphQL mutation กับ endpoint
GraphQL Queryดำเนินการ GraphQL query กับ endpoint

Modules

GraphQL Mutation

graphql.mutation

ดำเนินการ GraphQL mutation กับ endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL ของ GraphQL endpoint
mutationstringYes-สตริงของ GraphQL mutation
variablesobjectNo-ตัวแปรของ GraphQL mutation ในรูปแบบคู่คีย์-ค่า
headersobjectNo-HTTP headers เพิ่มเติมที่จะส่งพร้อมกับคำขอ
auth_tokenstringNo-Bearer token สำหรับการยืนยันตัวตน (เพิ่มเป็น Authorization header)

Output:

FieldTypeDescription
dataobjectข้อมูลการตอบกลับของ GraphQL
errorsarrayข้อผิดพลาดของ GraphQL (null ถ้าไม่มีข้อผิดพลาด)
status_codenumberรหัสสถานะ 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"}}

GraphQL Query

graphql.query

ดำเนินการ GraphQL query กับ endpoint

Parameters:

NameTypeRequiredDefaultDescription
urlstringYes-URL ของ GraphQL endpoint
querystringYes-สตริงของ GraphQL query
variablesobjectNo-ตัวแปรของ GraphQL query ในรูปแบบคู่คีย์-ค่า
headersobjectNo-HTTP headers เพิ่มเติมที่จะส่งพร้อมกับคำขอ
auth_tokenstringNo-Bearer token สำหรับการยืนยันตัวตน (เพิ่มเป็น Authorization header)

Output:

FieldTypeDescription
dataobjectข้อมูลการตอบกลับของ GraphQL
errorsarrayข้อผิดพลาดของ GraphQL (null ถ้าไม่มีข้อผิดพลาด)
status_codenumberรหัสสถานะ 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.