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.sh 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.sh, 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.sh 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 Loading

  1. github-action github-action Public

    GitHub action to deploy your API documentation on Bump

    TypeScript 42 9

  2. cli cli Public

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

    TypeScript 45 4

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

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

    Shell 2 3

  4. examples examples Public

    A curated list of example public OpenAPI and AsyncAPI definition files

    6 3

  5. cors-toujours cors-toujours Public

    This is a lightweight HTTP proxy server built using the Sinatra framework. It acts as a pass-through proxy, allowing requests to be forwarded to a specified target URL. Additionally, it provides a …

    Ruby 6 1

Repositories

Showing 10 of 17 repositories
  • cli Public

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

    bump-sh/cli’s past year of commit activity
    TypeScript 45 MIT 4 17 1 Updated Dec 18, 2024
  • docs Public

    Content hub for Bump.sh

    bump-sh/docs’s past year of commit activity
    CSS 2 12 6 3 Updated Dec 18, 2024
  • cors-toujours Public

    This is a lightweight HTTP proxy server built using the Sinatra framework. It acts as a pass-through proxy, allowing requests to be forwarded to a specified target URL. Additionally, it provides a JWT (JSON Web Token) verification mechanism to allow only specific requests.

    bump-sh/cors-toujours’s past year of commit activity
    Ruby 6 AGPL-3.0 1 2 0 Updated Dec 12, 2024
  • .github Public

    Bump.sh default community health file

    bump-sh/.github’s past year of commit activity
    0 1 0 0 Updated Dec 9, 2024
  • examples Public

    A curated list of example public OpenAPI and AsyncAPI definition files

    bump-sh/examples’s past year of commit activity
    6 3 0 0 Updated Dec 9, 2024
  • github-action Public

    GitHub action to deploy your API documentation on Bump

    bump-sh/github-action’s past year of commit activity
    TypeScript 42 MIT 9 7 9 Updated Dec 5, 2024
  • bump-ci-example Public

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

    bump-sh/bump-ci-example’s past year of commit activity
    Shell 2 MIT 3 1 4 Updated Dec 2, 2024
  • cors-anywhere Public Forked from Rob--W/cors-anywhere

    CORS Anywhere is a NodeJS reverse proxy which adds CORS headers to the proxied request.

    bump-sh/cors-anywhere’s past year of commit activity
    JavaScript 0 MIT 6,291 0 0 Updated Aug 16, 2024
  • Api-Platform-Demo Public

    Bootstrap API with ApiPlatform, with API changelog

    bump-sh/Api-Platform-Demo’s past year of commit activity
    TypeScript 0 MIT 1 0 4 Updated Jul 1, 2024
  • pg_search Public Forked from Casecommons/pg_search

    pg_search builds ActiveRecord named scopes that take advantage of PostgreSQL’s full text search

    bump-sh/pg_search’s past year of commit activity
    Ruby 0 MIT 377 0 0 Updated Nov 13, 2023