Integrate Speakeasy With Bump.sh

Overview

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.

Setting up the Integration

Prerequisites

IMPORTANT

Before continuing with this guide, ensure that the following prerequisites have been met:

• An Automated Code Sample URL has been configured for the desired Speakeasy SDK, and
• Created an account on Bump.sh.

Once those requirements have been met, proceed with the following steps.

Locate & Copy the Combined Spec URL

First, navigate to the Speakeasy Dashboard (opens in a new tab) and open the API Registry tab. Once there, open the *-with-code-samples entry for the desired API.

NOTE: If this entry is not labeled with Combined Spec, ensure that the API has an Automatic Code Sample URL configured.

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

Import the Combined Spec URL into Bump.sh

Next, head over to your Bump.sh dashboard and either create “New Documentation”, or open existing API documentation. Click “Settings” and open the “Automatic Deployment” tab.

Pick 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 just starting out, let’s start with the CLI. Open your 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>

After the import has completed, the API documentation will be rendered, and your SDKs will be embedded as code samples in each OpenAPI operation.

What Next?

This is a basic setup, so for more advanced configurations, you can refer to the Bump.sh and Speakeasy integration guide (opens in a new tab) which will demonstrate using GitHub Actions to automate deployments.

Bump.sh is much more than just an OpenAPI spec renderer, it offers API catalogs, discovering, and playgrounds. Learn more about Bump.sh on their official documentation (opens in a new tab).