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
Section titled “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
Section titled “Setting up the integration”Get the API’s combined spec public URL from the registry
Section titled “Get the API’s combined spec public URL from the registry”Navigate to the Speakeasy Dashboard and click on the Docs tab. Select the Integrate with a Docs Provider option.
On the Integrate with a Docs Provider page, select the correct OpenAPI document using the Change OpenAPI Documents button. Then, copy the Spec URL.
Make sure the Public toggle is enabled, so Mintlify can access the OpenAPI document.
Import the combined spec URL into Scalar
Section titled “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
Section titled “Next steps”Scalar is more than just an OpenAPI renderer. Visit the official Scalar documentation to learn more.