Integrate Speakeasy with Mintlify
Autogenerated code snippets from Speakeasy SDKs can be integrated directly into Mintlify API reference documentation. SDK usage snippets are shown in the interactive playground of Mintlify-powered documentation sites.
Prerequisites
To integrate Mintlify with Speakeasy, you’ll need the following:
- A Mintlify documentation repository .
- 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 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.
Update the configuration file
Add the combined spec URL to Anchors or Tabs in the configuration file of a Mintlify repository.
Note: Mintlify has transitioned from mint.json to docs.json as their primary configuration file. The configuration format remains the same, but the filename has changed.
Using docs.json (Recommended)
Add the combined spec URL to Anchors by updating the anchor field in the docs.json file as follows:
Add the combined spec URL to Tabs by updating the tab field in the docs.json file as follows:
Using mint.json (Legacy)
If you’re using the legacy mint.json configuration file, the format remains the same:
Speakeasy-generated code snippets can now be viewed in the Mintlify API reference documentation. See the code snippets in action in the interactive playground of the Mintlify-powered documentation site.
Next steps
Mintlify offers flexible customization options for API references generated from OpenAPI documents. For more information, refer to the Mintlify documentation .
Last updated on