Speakeasy

Automatiza los fragmentos de uso del SDK en el área de pruebas de API

Los fragmentos de código generados automáticamente por los SDK de Speakeasy se pueden integrar directamente en la documentación de referencia de API de Mintlify. Los fragmentos de uso del SDK se muestran en el área de pruebas interactiva de los sitios de documentación impulsados por 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 de muestras de código automatizadas configurada.

Configuración de 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 tu 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 aparece 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 anchor actualizando el campo anchor en tu archivo docs.json de la siguiente manera:

docs.json

{
  "anchors": [
    {
      "name": "API Reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL",
      "url": "api-reference",
      "icon": "square-terminal"
    }
  ]
}

Agrega la URL de la especificación combinada a una pestaña actualizando el campo tab en el archivo docs.json de la siguiente manera:

docs.json

{
  "tabs": [
    {
      "name": "API Reference",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}

Ahora, los fragmentos de código generados por Speakeasy se pueden ver en tu documentación de API y podrás interactuar con ellos en el área de pruebas.