Bump.sh

White text on a black background – **OpenAPI 3.2: The Complete Guide**

To accompany the release of #OpenAPI 3.2, we’ve updated our complete OpenAPI guide. Whether you’re looking to get started with the popular standard or explore its latest features in detail, it’s a valuable resource to keep close at hand.

docs.bump.sh/guides/opena...

Paris Meetup - Scaling API workflows with OpenAPI: from docs to AI, SDKs, and beyond · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

Are you coming to the @bumpsh.bsky.social meetup in Paris this evening? I am!

Come learn how to stop building APIs like a 2003 frontend developer. We’re talking about image sprites. We’re talking about CSS combination. We’re talking modern HTTP. It’s gonna be fun!

bump.sh/blog/meetup-...

OpenAPI 3.2 - What to expect? · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

On Friday, the brand-new OpenAPI update was released, moving to 3.2.
It brings a whole range of new features that will make life much easier: sub-tags, JSON streaming, and more…

Among all these new features, was there one in particular you’d been waiting for?
bump.sh/blog/openapi...

JSON Streaming in OpenAPI v3.2.0 · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

JSON Streaming is one of the main upcoming features in #OpenAPI 3.2, and as the name suggests, it allows you to send lots of small pieces of data to a browser (like pins on a map). Get ahead of this release: @philsturgeon.com has prepared a great guide on the topic!

bump.sh/blog/json-st...

We’re very proud that #RedPanda chose Bump.sh for their API #documentation, to provide the most comfortable experience for their users
With the aim of fully integrating into their existing site, they’re making the most of our new embed mode.
Go check it out!

docs.redpanda.com/redpanda-clo...

How to prepare for your API documentation revamp? · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

Revamping your #API docs is no small task. Here are a few key tips to help you dive in with confidence and prepare as best you can for what lies ahead.

bump.sh/blog/how-to-...

We’ve always had one clear goal at Bump.sh: to help you deliver great API documentation, and to help your users explore and understand your APIs effortlessly. | Sébastien Charrier We’ve always had one clear goal at Bump.sh: to help you deliver great API documentation, and to help your users explore and understand your APIs effortlessly. Today, we're making a big leap toward tha...

Integrating your API #documentation naturally into your existing resources, that’s exactly what our newly released Embed mode offers. Sébastien, our CEO, shares a few thoughts on how it came to be, right here:

www.linkedin.com/posts/sebast...

Generating OpenAPI docs for Java with Spring Boot · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

SpringDoc is a really cool tool that lets you generate #OpenAPI 3.1 specification files from any #Spring app, all you need to do is add annotations. To help you get started, @philsturgeon.com has put together this excellent guide:

bump.sh/blog/generat...

To make it easier to get started with overlays in #OpenAPI and #AsyncAPI, the maintainers of OpenAPI Format have created a web interface for working through a visual UI. And @philsturgeon.com has even put together a practical guide to help you dive in!

docs.bump.sh/guides/opena...

Our approach to Pride Month · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

This year, we decided to do things differently to show our support for #Pride Month. 🏳️‍🌈

bump.sh/blog/pride-s...

The 5 Best API Docs Tools in 2025 · Bump.sh From API contract to documentation portal: streamline your workflow and deliver the best API experience. Built for engineers and tech writers.

To help you make the right choice and find the #API documentation tool that fits your needs, @philsturgeon.com has put together a Top 5 of the best on the market. You can check it out right here:

bump.sh/blog/top-5-a...

We wanted to dress in our finest for the summer: the new Bump.sh website is live!

It's designed to help you get the very best out of your API documentation and to support you with guides and tips written by experts.

a photo of Arnaud Bourgin, new recruit at Bump.sh

From New York to Los Angeles, Arnaud spent nearly 10 years tirelessly optimizing extreme supply chains. Gripped by the urge for new adventures, he returned to Europe to shift into Business Development before joining us.

Welcome, Arnaud Bourgin!

Since the launch of its beta, our #API Explorer has continued to evolve based on user feedback. Discover the latest improvements in our newest product update:

docs.bump.sh/product-upda...

API Design Reviews Don’t Have to be Hard · Bump.sh An API Design Review is one of a few parts of a larger API Governance program, where various people review changes to an API to make sure its a good choice for the architecture and wider ecosystem. Th...

Dreading #API design reviews?
What if we made them actually useful?
@philsturgeon.com shows you how to integrate API design reviews into your #Git workflows and pull requests, without the friction.

📘 Read the full article: bump.sh/blog/api-des...

Documenting Multiple API Versions · Bump.sh Versioning an API can be incredibly difficult, but working out how to handle documentation for multiple APIs can be even more of a challenge. When you release a new version of an API you’re going to n...

Publishing a new version of your #API doesn't necessarily mean abandoning the previous ones, and maintaining them can quickly become complex. To make things easier for you, here’s a guide by @philsturgeon.com to help you better manage multiple versions of your APIs.

bump.sh/blog/multipl...

At @bumpsh.bsky.social, we often take the time to work on small but impactful enhancements between two larger project cycles, in moments called "Love cycles".

See the changelog in our last Product Update: docs.bump.sh/product-upda...

Forgetting to update API docs is like committing code without a message—technically it works, but future-you won’t be happy.
Docs as Code helps you make sure your documentation evolves with your API.
James Higginbotham lists a couple of cool perks you get with it.
bump.sh/blog/docs-as...

If your API guidelines feel more like "suggestions" than rules, OpenAPI can help. Automate standards, enforce consistency, and make governance a breeze. Less firefighting, more shipping.
James Higginbotham has some key tips for you about that: bump.sh/blog/leverag...

Talking about #OpenAPI and integrations, here's one that nails it: @stainless.com x Bump.sh.
Centered on API definitions, like a perfect modern workflow.
All activated through a GitHub Action.
And all about improving API onboarding and adoption for your users.
bump.sh/blog/bump-st...

@philsturgeon.com’s Modern #OpenAPI Workflow breakdown is the API guide you didn’t know you needed. After speaking with hundreds of teams, we can confirm this is how it’s done. Prepare to streamline your workflow and maybe even save a few headaches along the way.
docs.bump.sh/guides/opena...

Visually show the current state of your API with badges

We've been busy 🚀

You can now easily inform your users about the state of your APIs by adding custom badges to your operations and properties.

Learn more about it in our last Product Update: docs.bump.sh/product-upda...

Unlocking API Discovery with Bump.sh Hubs in Your Platform Engineering Strategy · Bump.sh APIs are at the core of modern enterprise architectures, powering integrations, automation, and digital products. Yet, API sprawl remains a persistent challenge—APIs are often scattered across differe...

📞 Your APIs called—they’re tired of being "discovered" only after a 12-tab deep dive.
Bump.sh Hubs gives your APIs the spotlight they deserve. No more hide-and-seek.
📝 Insights by James Higginbotham.
#APIDiscovery #DeveloperTools
bump.sh/blog/api-dis...

API Explorer - Authentication support This site contains the Bump.sh documentation, product updates descriptions, examples of how to use Bump.sh, as well as guides to help you build better REST APIs (OpenAPI) and event-driven architecture...

We've been busy at Bump.sh 🚀

I'm glad to announce that authentication is now supported in our API Explorer, to help your users easily connect to your APIs.

Learn more about it in our last Product Update!

You can request an access to the API Explorer Beta here: survey.typeform.com/to/RRACql9G

API Linting with vacuum · Bump.sh Whether just starting to build an API and looking for feedback, or improving auditing an old API to see if it's secure, consistent, and up to scratch, the approach is likely the same: API linting.

API Linting is an excellent practice that fits into a Design-First approach: it helps save a lot of time when verifying your definition files. @philsturgeon.bsky.social has put together a guide on vacuum (@quobix.bsky.social): it’s one of the best linters on the market.

bump.sh/blog/api-lin...

🎉 A big thank you to @bumpsh.bsky.social for joining the Microcks community as an adopter! 🚀

Looking for stunning API documentation and tools to identify breaking changes from API specs? Look no further.

👉 Check out this great article to see the powerful combo: https://buff.ly/3VpbwHT

Mermaid support This site contains the Bump.sh documentation, product updates descriptions, examples of how to use Bump.sh, as well as guides to help you build better REST APIs (OpenAPI) and event-driven architecture...

It’s often better with a diagram! We’ve just added #mermaid support to Bump.sh, allowing you to include diagrams and flowcharts directly in your documentation to make your #API easier to understand and adopt. More details here:

docs.bump.sh/product-upda...

A Developer's Guide to API Design-First · Bump.sh API Design-First, also known as "schema-first" or "contract-first", is all about designing the interface of an API before writing any code. It's about planning the API contract first, and defining wha...

Released some time ago, our API Design-first guide has just been updated. Phil Sturgeon revisits the relevance of this workflow, showing how it simplifies life for everyone throughout the #API lifecycle.

bump.sh/blog/dev-gui...

Speakeasy x Bump.sh: Publishing API docs with custom code samples powered by SDKs · Bump.sh 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.

With #Speakeasy, we firmly believe that #OpenAPI is often a game-changer, and the support for Overlays reinforces this idea.
We published a guide on this topic, showing how to generate your SDKs and retrieve custom code examples for your API doc.

bump.sh/blog/bump-sp...

Bump.sh 2024 Wrapped · Bump.sh The year where tech writers and engineers united

For the world of APIs, 2024 was an exciting year full of innovations. And for us, it was just as eventful: beyond the numerous features we deployed, we worked hard to make the use of documentation more seamless than ever. Here's a behind-the-scenes look.

bump.sh/blog/bump-20...