Integrate Speakeasy with Scalar
Scalar enables easy creation and maintenance of API documentation. Scalar renders documentation by referencing a live OpenAPI document, making it compatible with Speakeasy’s Automated Code Samples feature.
Prerequisites
To integrate Scalar with Speakeasy, you’ll need the following:
- A Scalar account. Sign up at https://dashboard.scalar.com/register .
- 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 and open the API Registry overview. Select the relevant API and open the entry labeled with type Combined Spec. This is typically at the bottom under “Related Documents”.
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 using the “Share” button on the top right.
Import the combined spec URL into Scalar
Open a Scalar project , go to the Reference tab, and click Import URL.
Paste the combined spec URL copied from Speakeasy into the provided field, optionally check Create Link, then click Import.
When the import is complete, the API documentation will be rendered.
Next steps
Scalar is more than just an OpenAPI renderer. Visit the official Scalar documentation to learn more.
Last updated on