/graphql

GraphQL API for Temporal Server

Primary LanguageHTMLMIT LicenseMIT

⚠️ This project is in alpha. We welcome feedback and contributions.

A GraphQL server that uses the TypeScript SDK to query Temporal Server. Built with Apollo Server.

Documentation site

GraphQL projects

  • This repo: A Node server that's able to decode Payloads (and encode arguments), but doesn't cover the entire Temporal API. Feel free to open PRs with more coverage.
  • temporalio/graphql-full: A Java GraphQL server that covers more gRPC methods but doesn't handle Payloads well.

Get started

git clone https://github.com/temporalio/graphql.git
cd graphql
npm i
npm run start.watch

Open localhost:4000 or point your GraphQL IDE (like GraphQL Studio) at http://localhost:4000/graphql.

Updating types

After you change src/schema.graphql, while your dev server is running (without errors), do:

npm run codegen

to update the types in src/generated-resolver-types.ts.