FAQs

FAQs

GraphQL lets you write your own operations to interact with the data you need - all in a single request. This section answers common questions about how GraphQL works and what to keep in mind when using it.

What is GraphQL?

GraphQL is a query language for APIs that allows clients to request exactly the data they need. Unlike REST, which requires multiple endpoints, GraphQL uses a single endpoint and lets you shape the response.

How is GraphQL different from REST?

• Single endpoint vs. multiple endpoints
• Client-driven queries vs. server-defined responses
• Efficient data fetching (no over-fetching or under-fetching)
• Strongly typed schema that defines all possible queries and mutations

Does GraphQL replace REST?

Not necessarily. GraphQL can complement REST, offering a more flexible approach without discarding legacy systems.

What are queries and mutations?

• Queries are used to fetch data.
• Mutations are used to modify data (create, update, delete).

What is a schema?

A schema defines the types and operations available in a GraphQL API. It acts as a contract between the client and server.

Can I use variables in GraphQL queries?

Yes, GraphQL supports variables which allow you to reuse queries with different inputs, making your operations more dynamic and secure.

How do I handle errors in GraphQL?

GraphQL responses include an errors field alongside data. You can inspect this to handle issues gracefully in your application.

How does GraphQL impact performance?

GraphQL improves network performance by allowing clients to request only the data they need - no more over-fetching or under-fetching. This results in faster, leaner responses and better user experiences.

However, flexibility comes with trade-offs. Poorly designed queries can lead to backend inefficiencies, such as deep or overly complex queries that strain server resources

Tips for users when writing GraphQL queries:

• Limit nested fields unless necessary.
• Use fragments to reuse query parts.
• Avoid requesting large lists without pagination.

To learn more visit Key Benefits for deeper insights into benefits and trade-offs.

Does GraphQL use HTTP?

GraphQL typically uses HTTP POST to send queries and mutations to a single endpoint:

https://api.n-able.com/graphql

While HTTP is the most common transport protocol, GraphQL itself is network agnostic - meaning it can operate over other protocols such as WebSockets for subscriptions. This flexibility simplifies integration with existing web infrastructure while supporting real-time and alternative transport options when needed.

What’s the difference between REST and GraphQL in our platform?

REST uses multiple endpoints and fixed responses. GraphQL uses one endpoint and lets customers shape their responses. This reduces over-fetching and improves performance.

What are common use cases for our GraphQL API?

Customers typically use GraphQL to:

• Fetch asset data for reporting.
• Streamline workflows with fewer API calls.
• Access data not available in the UI or REST APIs.

Resources

• Official GraphQL Docs
• GraphQL Playground
• How to GraphQL Tutorials
• Apollo GraphQL Blog