Speakeasy

Automatiza los ejemplos de código del SDK en tu á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 de los sitios de documentación con tecnología de Mintlify.

​

Requisitos previos

Para integrar Mintlify con Speakeasy, necesitarás lo siguiente:

• Un repositorio de documentación de Mintlify.
  • Un SDK generado por Speakeasy con una URL automatizada de ejemplo de código configurada.

​

Configurar la integración

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.

​

Obtén la URL pública de la especificación combinada de la API desde el registro

Ve a tu Speakeasy Dashboard y abre la pestaña API Registry. Abre la entrada *-with-code-samples de la API.

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.

Desde la página de la entrada en el registro, copia la URL pública proporcionada.

​

Actualiza tu archivo de configuración docs.json

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:

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:

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.