In the modern API landscape, developers expect more than just an API reference when getting started with an API. Providing comprehensive guides, tutorials, and up-to-date code samples can be the difference between a user choosing your solution — or going with a competitor.
But building and maintaining a developer hub is costly for engineering and can create time-consuming bottlenecks for making the updates required to keep API docs current. As these legacy “developer portals” require more and more engineering support, both your teams and your developers suffer, leading to slowdowns in API adoption and dissatisfaction all around.
We’re laser-focused on solving this problem here at ReadMe, where we enable more than 3000 leading API teams to build personalized, interactive developer hubs that ultimately help developers succeed. And today, we’re proud to share that we’re an official Amazon API Gateway partner to provide best-in-class developer hubs for any team that creates, maintains, and secures their APIs with Amazon API Gateway 🎉
Outdated API docs? Never again.
With the ReadMe integration for API Gateway, your API definition and any subsequent updates — whether made manually or through a CI/CD pipeline — are automatically synced to your developer hub in ReadMe. From there, your team can use ReadMe's Markdown-based editor to add long-form Guides, step-by-step Recipes, code samples, and any other helpful documentation to give developers a jump start with your API through your developer hub.
It’s easy for non-engineers to contribute to your docs, and you save time on costly engineering bottlenecks to deploy updates to your documentation. But getting this workflow flexibility doesn’t mean sacrificing efficiency for your engineering team: once the ReadMe integration has been configured, your API reference stays updated automatically directly from API Gateway. Think of ReadMe as your out-of-the-box developer hub for your API.
Surface API keys right when they’re needed
Docs shouldn’t just be static words on a page — they’re a key way for developers to learn about and interact with your APIs, so you can think of them as a product experience, too.
That’s why ReadMe variables allow you to inject custom user data into your docs to surface the details each developer needs, right when they need them. Instead of showing users convoluted screenshots and instructions for how to find their API key or other authentication info, variables bring those details right to your docs whenever a developer logs in.
A better experience for your developers — and your team
Together, Amazon API Gateway and ReadMe provide a complete end-to-end solution for your developer experience: create, maintain, and secure your APIs with API Gateway, and enable developers to get started and troubleshoot easily with ReadMe. ReadMe's easy-to-edit interface makes building and hosting your developer hub a snap:
📉 Reduce maintenance costs
Your API reference is automatically updated using the seamless Amazon API Gateway integration, and team members can quickly edit guides or other docs directly in ReadMe.
⏰ Faster “time to first call”
Developers can explore what’s possible in your guides, then dive right into the Try It playground in your API reference to make their first call in real time.
🛠 Streamline API troubleshooting
Sample code snippets help developers get on track, and shareable API request logs make it easy for your support team to dig into and debug any integration issues.
🚀 Drive API adoption
Announce new versions, endpoints, and other functionality in your built-in changelog and version documentation to support your users over time.
We’re here to help
If you’re already an Amazon API Gateway customer, we’d love to help get you set up with ReadMe. Take a look at the comprehensive docs to get started, and if you’re not already using ReadMe, you can sign up for a free trial or request a demo on our website. Looking forward to building with you!