GraphQL API Reference (Limited Support)

⚠

️ Support for GraphQL is limited

If you’re interested in using the product, 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’ve released what we’ve built so far 🎉 If you’re using GraphQL for your APIs, we’d love for you to share your feedback!

🗓 What's supported?

We’ve built a playground for GraphQL APIs. Developers can use the playground to explore your API, build queries, and make requests.

If your API requires authentication, we can set their authentication info in the request headers when they log in by setting up JWT or our personalized docs webhook.

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

🥳 Enable GraphQL!

If you’re interested in using ReadMe to set 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 feature 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!

❓ Have questions or need help?

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