mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
4c411f7dea
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
86 lines
3.5 KiB
Plaintext
86 lines
3.5 KiB
Plaintext
---
|
|
title: "Speakeasy"
|
|
description: "Automatiza los ejemplos de código del SDK en tu área de pruebas de la API."
|
|
keywords: ["Speakeasy SDK", "SDK autogenerados", "ejemplos de código del SDK", "integración del área de pruebas de la API"]
|
|
---
|
|
|
|
Los fragmentos de código autogenerados de los SDK de Speakeasy pueden integrarse directamente en la documentación de referencia de la API de Mintlify. Los ejemplos de uso del SDK se muestran en el [área de pruebas interactiva](/es/api-playground/overview) de los sitios de documentación con tecnología de Mintlify.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
<div id="prerequisites">
|
|
## Requisitos previos
|
|
</div>
|
|
|
|
Para integrar Mintlify con Speakeasy, necesitarás lo siguiente:
|
|
|
|
* Un [repositorio de documentación de Mintlify](/es/quickstart).
|
|
* Un SDK generado por Speakeasy con una [URL automatizada de ejemplo de código](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls) configurada.
|
|
|
|
<div id="setting-up-the-integration">
|
|
## Configurar la integración
|
|
</div>
|
|
|
|
Para integrar Speakeasy con Mintlify, debes obtener la URL pública de la especificación combinada de la API desde el registro y actualizar el archivo de configuración `docs.json`.
|
|
|
|
<div id="get-the-apis-combined-spec-public-url-from-the-registry">
|
|
### Obtén la URL pública de la especificación combinada de la API desde el registro
|
|
</div>
|
|
|
|
Ve a tu [Speakeasy Dashboard](https://app.speakeasy.com) y abre la pestaña **API Registry**. Abre la entrada `*-with-code-samples` de la API.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
<Note>
|
|
Si la entrada no está marcada como **Combined Spec**, asegúrate de que la API tenga configurada una [URL automática de ejemplos de código](https://www.speakeasy.com/docs/code-samples/automated-code-sample-urls).
|
|
</Note>
|
|
|
|
Desde la página de la entrada en el registro, copia la URL pública proporcionada.
|
|
|
|
<Frame>
|
|

|
|
</Frame>
|
|
|
|
<div id="update-your-docsjson-configuration-file">
|
|
### Actualiza tu archivo de configuración `docs.json`
|
|
</div>
|
|
|
|
Agrega la URL de la especificación combinada a una sección de **Anchors** o **Tabs** en tu archivo `docs.json`.
|
|
|
|
Agrega la URL de la especificación combinada a un ancla actualizando el campo `anchor` en tu archivo `docs.json` de la siguiente manera:
|
|
|
|
```json docs.json
|
|
{
|
|
"anchors": [
|
|
{
|
|
"name": "Referencia de la API",
|
|
// !mark
|
|
"openapi": "SPEAKEASY_COMBINED_SPEC_URL",
|
|
"url": "api-reference",
|
|
"icon": "square-terminal"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Agrega la URL de la especificación combinada a un Tab actualizando el campo `tab` en el archivo `docs.json` de la siguiente manera:
|
|
|
|
```json docs.json
|
|
{
|
|
"tabs": [
|
|
{
|
|
"name": "Referencia de la API",
|
|
"url": "api-reference",
|
|
// !mark
|
|
"openapi": "SPEAKEASY_COMBINED_SPEC_URL"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
Ahora puedes ver los fragmentos de código generados por Speakeasy en tu documentación de la API e interactuar con ellos en el playground.
|