Fast 💨 (hono benchmarks - yoga benchmarks), maximally extensible 🔗, globally distributed 🌐, deployed at the edge using Cloudflare Workers 🔶
| One Click Deploy | Instant Development |
|---|---|
 |
Hono as a base router, GraphQL Yoga server, runs on Cloudflare Workers runtime.
This stack is maximally extensible. To extend the GraphQL server functionalities, see Envelop Plugins – there's a plugin for everything you need. To extend Hono (the router), see the list of middlewares – on the left side menu is the list of official middlewares and on the page itself is a list of community middlewares.
Clone the repo and install dependencies:
gh repo clone o-az/workers-graphql
cd workers-graphql
# if you don't have github cli `gh`, you should
# git clone https://github.com/o-az/workers-graphqlInstall dependencies and start the development server:
pnpm install
pnpm devexamples on how to query, subscribe, access playground, introspect, see cache, etc.
workers-graphql.evm.workers.dev/graphiql
Usually GraphQL queries are sent as POST requests but here we can also send them as GET requests. We encodeURIComponent the query and add it to the URL as a query parameter. GET example:
curl --request GET \
--url 'https://workers-graphql.evm.workers.dev/graphql?query=%7B+health+%7D'Classic POST example:
curl --request POST \
--url https://workers-graphql.evm.workers.dev/graphql \
--header 'content-type: application/json' \
--data '{ "query": "{ health }" }'subscription {
countdown(from: 3)
}Notice the Accept: text/event-stream header.
# GET request
curl --request GET \
--header 'Accept: text/event-stream' \
--url 'https://workers-graphql.evm.workers.dev/graphql?query=subscription%7Bcountdown%28from%3A3%29%7D'
# output
# event: next
# data: {"data":{"countdown":3}}
# event: next
# data: {"data":{"countdown":2}}
# event: next
# data: {"data":{"countdown":1}}
# event: next
# data: {"data":{"countdown":0}}
# event: complete.graphql schema:
pnpm dlx @graphql-inspector/cli \
introspect https://workers-graphql.evm.workers.dev/graphql \
--write schema.graphql
# or npx, or yarn dlx, or bunx.json schema:
pnpm dlx @graphql-inspector/cli \
introspect https://workers-graphql.evm.workers.dev/graphql \
--write schema.json
# or npx, or yarn dlx, or bunxYou can also introspect with a curl request:
# assuming you have jq installed
curl --silent --location \
--request POST \
--url 'https://workers-graphql.evm.workers.dev/graphql' \
--header 'Content-Type: application/json' \
--data '{"query":"query IntrospectionQuery { __schema { description queryType { name description } mutationType { name description } subscriptionType { name description } types { ...FullType } directives { name description locations args { ...InputValue } } } } fragment FullType on __Type { kind name description fields(includeDeprecated: true) { name description args { ...InputValue } type { ...TypeRef } isDeprecated deprecationReason } inputFields { ...InputValue } interfaces { ...TypeRef } enumValues(includeDeprecated: true) { name description isDeprecated deprecationReason } possibleTypes { ...TypeRef } } fragment InputValue on __InputValue { name description type { ...TypeRef } defaultValue } fragment TypeRef on __Type { kind name description ofType { kind name description ofType { kind name description ofType { kind name description ofType { kind name description ofType { kind name description ofType { kind name description ofType { kind name description } } } } } } } }","variables":{}}' \
| jq '.data' > schema.jsonI manually set the resolver of this query to take 5 seconds for the first request. Then subsequent requests will be served from the cache for the next n seconds.
To find out how long the cache is set to, search for @cacheControl in ./src/graphql.ts.
To try this, visit workers-graphql.evm.workers.dev/graphql?query=%7B+slow+%7D in the browser.
Run the query, notice the slowness, and then run it again a few times to see the cache in action.