mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
skeptrune
9200586a3a
* docs: boost search ranking for single-word title pages Apply `boost: 3` to English pages whose H1 / frontmatter title is a single word (e.g. "Assistant", "Quickstart", "Cards"). Short titles tend to be canonical landing pages for a topic, so users searching the exact term should land on them first. * docs: drop boost on websocket-playground stub to keep canonical Playground ranking `api-playground/websocket-playground.mdx` is an auto-generated AsyncAPI stub with no body content but shares the title "Playground" with `api-playground/overview.mdx`. Boosting both equally diluted the canonical overview page in search for the query "playground". Drop the boost on the stub.
79 lines
2.9 KiB
Plaintext
79 lines
2.9 KiB
Plaintext
---
|
|
title: "Speakeasy"
|
|
description: "Display autogenerated SDK code samples from Speakeasy in your API playground with multi-language examples for Python, TypeScript, Go, and more."
|
|
keywords: ["Speakeasy SDK", "autogenerated SDKs", "SDK code samples", "API playground integration"]
|
|
boost: 3
|
|
---
|
|
|
|
You can integrate autogenerated code snippets from Speakeasy SDKs directly into Mintlify API reference documentation. SDK usage snippets appear in the [interactive playground](/api-playground/overview) of Mintlify-powered documentation sites.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
## Prerequisites
|
|
|
|
To integrate Mintlify with Speakeasy, you'll need the following:
|
|
|
|
- A [Mintlify documentation repository](/quickstart).
|
|
- A Speakeasy-generated SDK with a configured [automated code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls).
|
|
|
|
## Setting up the integration
|
|
|
|
To integrate Speakeasy with Mintlify, you must get the API's combined spec public URL from the registry and update your `docs.json` configuration file.
|
|
|
|
### Get the API's combined spec public URL from the registry
|
|
|
|
Navigate to your [Speakeasy Dashboard](https://app.speakeasy.com) and open the **API Registry** tab. Open the `*-with-code-samples` entry for the API.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
<Note>
|
|
If the entry is not labeled **Combined Spec**, ensure that the API has an [automatic code sample URL](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configured.
|
|
</Note>
|
|
|
|
From the registry entry's page, copy the provided public URL.
|
|
|
|
<Frame>
|
|
|
|
</Frame>
|
|
|
|
### Update your `docs.json` configuration file
|
|
|
|
Add the combined spec URL to an **Anchors** or **Tabs** section in your `docs.json` file.
|
|
|
|
Add the combined spec URL to an anchor by updating the `anchor` field in your `docs.json` file as follows:
|
|
|
|
```json docs.json
|
|
{
|
|
"anchors": [
|
|
{
|
|
"name": "API Reference",
|
|
// !mark
|
|
"openapi": "SPEAKEASY_COMBINED_SPEC_URL",
|
|
"url": "api-reference",
|
|
"icon": "square-terminal"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Add the combined spec URL to a tab by updating the `tab` field in the `docs.json` file as follows:
|
|
|
|
```json docs.json
|
|
{
|
|
"tabs": [
|
|
{
|
|
"name": "API Reference",
|
|
"url": "api-reference",
|
|
// !mark
|
|
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
You can now view Speakeasy-generated code snippets in your API docs and interact with them in the playground.
|