GraphQL API Reference (Beta)

⚠

️ Support for GraphQL is currently in beta

If you’re interested in joining the beta, email [email protected] or send us a message through Intercom, and we'll reach out to get you set up!

👩‍💻 What's GraphQL?

GraphQL is a query language for APIs that has quickly gained popularity over the last few years as an alternative to REST. As more developers build their APIs in GraphQL, we want to be able to support them with a best-in-class API reference and documentation solution for GraphQL. But that takes some work… and time ⏲️

The good news? We’re releasing what we’ve built so far in a limited beta 🎉 If you’re using GraphQL for your APIs, we’d love for you to join the beta and share your feedback!

🗓 What's included in the beta?

We’ve built an interactive, “playground-like” GraphQL API Reference experience where you can explore GraphQL APIs and make queries. With GraphQL, you get to choose the query parameters you want to see, which is a big difference from REST APIs.

Here’s Marc, ReadMe’s Head of Product, walking you through what's available in the GraphQL beta:

🥳 Join the beta!

If you’re interested in joining the beta and setting up a GraphQL API Reference, just reach out to our support team via email ([email protected]) or contact us in-app by sending us an Intercom message. Once we’ve enabled the beta in your ReadMe project, a new "GraphQL" settings page will appear in your dashboard.

From this page, you'll see a field to input your GraphQL API URL and a toggle to enable the GraphQL Reference in your developer hub:

Once GraphQL has been toggled on, the GraphQL reference will appear in the top navigation of your docs, and you’ll have a styled playground experience to test out the look and feel of ReadMe's GraphQL API Reference support!

❌ What's not included in the beta?

As we expand the beta, we'll continue to add new features based on customer feedback. Here's a quick look at what's coming down the pipe already!

• Search: In this beta version, nothing from the GraphQL schema will appear in a documentation-wide search. Users will still be able to search GraphQL specific fields in the documentation pane to the left of the playground, but that field isn't yet integrated into the rest of the project-wide search. This is intentional and we’re working on improving search functionality as part of our next release!
• Markdown content: The beta version of the GraphQL page doesn’t have support for adding markdown content. If you want to add markdown content, it’s best to do so in the Guides section.

❓ Have questions or need help?

Reach out to support ([email protected]) if you've got any GraphQL-related questions!