Integrate Speakeasy With Scalar

Overview

Scalar makes creating and maintaining API documentation very easy. It is able to to render documentation by referencing a live OpenAPI spec, making it a great tool to use in conjunction with Speakeasy’s Automated Code Samples feature.

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 Scalar.

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 Scalar

Next, open a Scalar project (opens in a new tab), open the Reference tab, then click Import URL.

Finally, paste the copied URL into the provided field, check Create Live Link (optional), then click Import.

After the import process has completed, the API documentation will be rendered.

What Next?

Scalar is much more than just an OpenAPI spec renderer. Continue to learn more about Scalar by visiting their official documentation (opens in a new tab).