gotql
A Node.js GraphQL client that lets you write queries as JSON objects instead of strings.
What is gotql?
GotQL is a Node.js library that serves as a GraphQL client for server-side applications. It allows developers to write GraphQL queries and mutations as JSON objects rather than strings, simplifying query construction and manipulation. It wraps the Got HTTP client to execute these queries against GraphQL endpoints.
Node.js developers building server-side applications that need to interact with GraphQL APIs, especially those who find string-based GraphQL query construction tedious or error-prone.
Developers choose GotQL because it eliminates the pain of string manipulation for GraphQL queries, offering a more programmatic, readable, and maintainable way to build and execute queries using familiar JavaScript objects.
Overview
GraphQL query utility for serverside apps
Use Cases
Best For
- Building server-side Node.js applications that consume GraphQL APIs
- Programmatically generating dynamic GraphQL queries without string concatenation
- Improving code readability and maintainability in GraphQL-heavy projects
- Integrating GraphQL APIs with custom HTTP client configurations
- Developing tools or scripts that need to construct and run GraphQL queries
- Teams wanting a more structured approach to GraphQL query building
Not Ideal For
- Client-side web or mobile applications, as GotQL is designed for server-side Node.js environments only.
- Projects requiring GraphQL subscriptions for real-time data, since GotQL only supports queries and mutations.
- Teams heavily invested in string-based GraphQL tooling, such as code generators or IDE plugins that expect raw query strings.
- Applications needing extensive use of GraphQL fragments, as support is currently in alpha and not thoroughly tested per the README.
Pros & Cons
Pros
Allows developers to construct GraphQL queries as JavaScript objects instead of strings, reducing manipulation errors and improving readability, as demonstrated in the motivation example comparing a complex string mutation to a clean JSON object.
Leverages the robust Got library under the hood, providing configurable HTTP options like headers, HTTP/2 support, and custom instances for reliable server-side requests.
Includes a `literal` helper for handling GraphQL enums without escaping, and straightforward variable definition to avoid common pitfalls, as shown in examples with enum args and variable declarations.
Supports debug levels via the `debug` package and allows customization of error status codes, headers, and HTTP settings through the options object, enhancing developer control.
Cons
The README explicitly states that fragment support is in an 'alpha state' and not as tested or polished as desired, which could lead to instability or missing features in production use.
GotQL only handles queries and mutations, completely missing GraphQL subscriptions, a key feature for real-time applications, limiting its utility for modern GraphQL APIs.
Designed specifically for Node.js server environments and relies on the Got HTTP client, making it unsuitable for client-side JavaScript or browser-based projects, as noted in the GitHub description.
Frequently Asked Questions
Related Projects
axiosPromise based HTTP client for the browser and node.js
superagentAjax for Node.js and browsers (JS HTTP client). Maintained for @forwardemail, @ladjs, @spamscanner, @breejs, @cabinjs, and @lassjs.
got🌐 Human-friendly and powerful HTTP request library for Node.js
node-fetchA light-weight module that brings the Fetch API to Node.js
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.