Blog Speakeasy x Bump.sh: Publishing API docs with custom code samples powered by SDKs

Speakeasy x Bump.sh: Publishing API docs with custom code samples powered by SDKs

It’s been a while since we chatted with the Speakeasy folks. What’s more natural? Bump.sh and Speakeasy are the first two vendors ever to officially support OpenAPI Overlays.

In a few words, Speakeasy is a complete platform for building API SDKs. Our tooling empowers teams to use OpenAPI to create robust SDKs, enhance API docs with custom code examples, Terraform providers and end-to-end testing.

If you’re sometimes reading our content, you’ve probably seen us talk a lot about our belief this specification changes the game in many use cases. Cool side-perk, by the way: it’s built for OpenAPI, but also works for AsyncAPI with Bump.sh.

We’re now writing this post because we recently released a guide that gives a very specific and powerful example of what Overlays can achieve: populating language-specific examples through the x-codeSamples extension. And in that spot, Speakeasy raises the bar, by generating SDKs AND the Overlays that contain those examples.

What’s left? Well, automate that process with our CI integration. Anytime you update your API structure (and contracts), you end up with fully up-to-date SDKs and docs with the proper examples in any of your supported languages.

Get up-and-running in a few steps.

Missing SDKs in your API doc portals, or API docs to publish along with your SDKs? Reach out to us, we can help.

Continue Reading

Preview your documentation using a Swagger, OpenAPI or AsyncAPI file.

Try it with an OpenAPI or an AsyncAPI example.

We use essential cookies and optional ones for your experience and marketing. Read our Cookie Policy.