Integrate Speakeasy with Bump.sh

Bump.sh is a hosted solution for simple API documentation, API catalogs, and API explorers, which makes it a great tool to use in conjunction with Speakeasy’s Automated Code Samples feature. Embed your SDKs right into the API documentation, making it easier for developers to get started with your API.

Prerequisites

To integrate Bump.sh with Speakeasy, you’ll need the following:

• A Bump.sh account. Sign up at https://bump.sh/users/sign_up (opens in a new tab).
• A Speakeasy-generated SDK with a configured automated code sample URL.

Setting up the integration

Get the API’s combined spec public URL from the registry

Navigate to the Speakeasy Dashboard (opens in a new tab) and open the API Registry tab. Open the *-with-code-samples entry for the API.

NOTE: If the entry is not labeled Combined Spec, ensure that the API has an automatic code sample URL configured.

From the registry entry’s page, copy the provided public URL.

Get the API’s combined spec public URL from the registry

In the Bump.sh dashboard, either create New Documentation or open existing API documentation. Click Settings and open the Automatic Deployment tab.

Select whether you want to deploy via GitHub Actions or CLI, and copy the appropriate example, which will include the Doc ID and the API token for you.

If you’re new to Bump.sh, start with the CLI. Open a terminal and run the following command:

npm install -g bump-cli

bump deploy https://spec.speakeasy.com/walker/walker/book-club-oas-with-code-samples
  --token=<your-api-token>
  --doc=<your-doc-id>

When the import is complete, the API documentation will be rendered, and Speakeasy-generated code samples will be embedded in the relevant OpenAPI operations.

Import the combined spec URL into Bump.sh

For more advanced configurations than this basic setup, refer to the Bump.sh and Speakeasy integration guide (opens in a new tab), which demonstrates using GitHub Actions to automate deployments.

Bump.sh is more than just an OpenAPI renderer – it also provides API catalogs, discovery tools, and interactive playgrounds. Learn more about Bump.sh in the official documentation (opens in a new tab).