API Reference
Generated reference for every public grx package, sourced from Go doc comments.
Use this section when you already know which package or symbol you need. It lists the public Go API and links each package to its detailed reference page. For explanations and complete tasks, start with Run your first server or choose a topic from Why grx.
The package pages are generated from Go doc comments. If a symbol description is incorrect, update the comment in the source tree and regenerate the reference pages.
Packages
| Package | What it covers |
|---|---|
grx | Root package: NewServer (WithSchema, plugins, transports, playground paths, WithFieldAuthorizer / WithOperationAuthorizer). |
core | Shared types: Request, Response, Error, Executor, Transport, OperationKind. No upward imports. |
schema | Code-first schema builder (schema.Config, schema.Build). Reflects user Go types into runtime metadata. |
exec | Lexer, parser, AST, executor, introspection fast-path. |
server | http.Handler, GraphiQL playground, transport dispatch (auto-appends the http transport). |
plugins | Plugin lifecycle interface, plugins.Base no-op embed. |
plugins/logger | Built-in log/slog-backed request logger. |
http | GraphQL-over-HTTP+JSON transport (the canonical POST /graphql request). |
sse | GraphQL over Server-Sent Events transport. |
websocket | RFC 6455 WebSockets implementing the graphql-transport-ws subprotocol. |
pubsub | Backend-neutral byte-oriented pub/sub contract. |
memory | Process-local PubSub implementation. |
redis | Redis-backed PubSub implementation in a separate Go submodule. |
Hosted Go documentation
For the canonical, always-up-to-date reference rendered exactly the way the rest of the Go ecosystem renders it, see pkg.go.dev. The content here comes from the same source comments. This site places those comments inside the rest of the grx documentation so navigation stays in one place.
Last updated on