docs/helpers/GraphQL.md
Extends Helper
GraphQL helper allows to send additional requests to a GraphQl endpoint during acceptance tests. Axios library is used to perform requests.
GraphQL: {
endpoint: 'http://site.com/graphql/',
onRequest: (request) => {
request.headers.auth = '123';
}
}
Send GraphQL requests by accessing _executeQuery method:
this.helpers['GraphQL']._executeQuery({
url,
data,
});
config Executes query via axios call
request object Prepares request for axios call
Returns object graphQLRequest
Adds a header for Bearer authentication
// we use secret function to hide token from logs
I.amBearerAuthenticated(secret('heregoestoken'))
accessToken (string | CodeceptJS.Secret) Bearer access tokenSets request headers for all requests of this test
headers object headers listSend query to GraphQL endpoint over http
I.sendMutation(`
mutation createUser($user: UserInput!) {
createUser(user: $user) {
id
name
email
}
}
`,
{ user: {
name: 'John Doe',
email: '[email protected]'
}
},
});
mutation String variables object? that may go along with the mutationoptions object? are additional query optionsheaders object?Returns any Promise<any>
Send query to GraphQL endpoint over http. Returns a response as a promise.
const response = await I.sendQuery('{ users { name email }}');
// with variables
const response = await I.sendQuery(
'query getUser($id: ID) { user(id: $id) { name email }}',
{ id: 1 },
)
const user = response.data.data;
query String variables object? that may go along with the queryoptions object? are additional query optionsheaders object?Returns any Promise<any>