TestingAPIs is still being built. If something breaks, email support@testingapis.com.

Tutorial

Learn GraphQL

GraphQL puts a whole API behind one URL and lets the client say which fields it wants. That changes what a tester has to check. Status codes say less, the response shape depends on the request, and a single endpoint can be asked almost anything.

These lessons assume you have sent an HTTP request before and can read JSON. If not, the first lessons of the API testing tutorial cover that. Every query here was run against the GraphQL endpoint at https://api.testingapis.com, and the responses shown are the ones it sent back. The GraphQL endpoint needs a free account; the examples and Send buttons work once you're signed in.

8 lessons3 levelsFree

Beginner

3 lessons

What a GraphQL request is, how to write a query, and how to pass values in without editing it.

  1. 01What GraphQL isOne endpoint, one POST, and a response shaped like the question.
  2. 02Writing queriesFields, arguments, nested objects, aliases and operation names.
  3. 03Variables, fragments and directivesKeeping values out of the query string, and reusing pieces of a query.

Intermediate

3 lessons

The schema, mutations and the errors array: where GraphQL testing parts ways with REST.

  1. 04Reading the schemaTypes, the exclamation mark, lists, and asking the server to describe itself.
  2. 05Testing mutationsCreating, changing and deleting data, and proving each change happened.
  3. 06Errors and status codesWhy a failed query can come back as 200, and what to assert instead.

Advanced

2 lessons

Tests written as code, and the security and load problems that come with one flexible endpoint.

  1. 07Automating GraphQL testsA small client, a test file in JavaScript or Python, and the checks worth keeping.
  2. 08Security and performanceIntrospection, query cost, aliases, GET requests and the N+1 problem.