Bump.sh helps you create API documentation hubs
that make your APIs discoverable and facilitate team collaboration.
AsyncAPI has become the standard for asynchronous APIs and Event-Driven Architecture (EDA) and is compatible with many protocols like Kafka, RabbitMQ, MQTT, AMQP, etc. Bump.sh helps you publish documentation for your entire API ecosystem.
Starting from AsyncAPI 2.0, your definition can be published with Bump.sh in a few seconds. We automatically recognize its format and version, and create the documentation for your Event-Driven Architecture needs.
Bump.sh displays examples from your API definitions directly in your documentation, with a clear and efficient view. If you don’t have any written by your team, we automatically generate examples from your API schema. Bump.sh knows how to work with JSON Schema… and soon with Avro Schema too.
With references, you can reuse your schemas across all your API specs. References are fully integrated to Bump.sh, resolved in the same file, on a file system or from distant URLs. Following JSON schema integration to AsyncAPI, Bump.sh recognizes and resolves them, instantly.
Bindings are an essential part of AsyncAPI and are fully supported by Bump.sh, regardless of their level. Your protocol-specific settings are displayed at the right place, at the right time.
Thanks to Markdown support, your documentation can become more user-friendly and share the context they need to get on track quickly. Add a getting-started introduction, highlight important parts or elements you do not want your community to miss... The choice is yours.
Sync your code with our CI integration and keep your documentation always up-to-date. You won’t need to worry anymore about obsolete documentation.
An elegant and purposeful API change management solution built on the foundation of OpenAPI and AsyncAPI, helping ensure that your API documentation is future proof.
With Bump.sh we can provide a clean and modern documentation to Exoscale's OpenAPI endpoints.
Getting it integrated in our pipeline was a breeze, highly recommended.
Bump.sh is a pioneer solution in offering docs and changelog for REST APIs and event-driven APIs.
