Skip to content
@bump-sh

Bump.sh

Bump is the first API contract management platform that helps document and track APIs.

Help | Sign up

Bump.sh LinkedIn Twitter Follow Mastodon Follow Reddit Follow YouTube Follow

Bump allows you to easily generate your API documentation and API changelog.

From an OpenAPI or AsyncAPI specification, you can deploy your API documentation in a couple of minutes. You can customize your documentation UI (title, colors, menu), protect it with a password, and customize its URL with your own domain.

Share a link to your documentation with your API consumers and help them to never miss an API change again. They will have the possibility to track API structural changes if they subscribe by email. Once a week, subscribers will receive a changelog digest of your documentation if your API has changed. Curious? Here is the API documentation changelog of our own API.

To make the most out of Bump, we suggest integrating our tool in your development process. We offer a Command Line Interface and Continuous Integration examples to let you: view API diff during code review thanks to our Github Action, Bump will automatically comment your pull requests with changes digest, then once merged we will deploy your changes directly to your documentation page.

If you work in a multiple services environment and have many different APIs, we got you covered. You can organize and mix your OpenAPI and AsyncAPI based documentations in a developer Hub. You will thus have all of your APIs listed in one place. Check our demo “Train company” hub for a live example.

Pinned

  1. github-action github-action Public

    GitHub action to deploy your API documentation on Bump

    TypeScript 41 9

  2. cli cli Public

    Bump.sh CLI - Deploy your OpenAPI & AsyncAPI documentations from your CI

    TypeScript 35 2

  3. bump-ci-example bump-ci-example Public

    CI integration examples for Github Action, Travis CI, CircleCI and Gitlab CI.

    Shell 1 2

  4. examples examples Public

    A curated list of example public OpenAPI and AsyncAPI definition files

    4 2

Repositories

Showing 10 of 15 repositories