Speakeasy

Puedes integrar fragmentos de código autogenerados de los SDK de Speakeasy directamente en la documentación de referencia de la API de Mintlify. Los ejemplos de uso del SDK aparecen en el área de pruebas interactiva de los sitios de documentación con tecnología de Mintlify.

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.

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.

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

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

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:

{
  "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:

{
  "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.

Después de volver a desplegar tu documentación, abre cualquier endpoint en tu referencia de API y confirma que los fragmentos de código aparecen en el playground. El conjunto de lenguajes disponibles coincide con los targets de SDK configurados en tu proyecto de Speakeasy.

Si los fragmentos no aparecen, comprueba lo siguiente:

• La URL de openapi en docs.json apunta a la entrada de la especificación combinada *-with-code-samples, no al archivo OpenAPI de origen.
• La URL de la especificación combinada es accesible públicamente desde el navegador.
• Tu proyecto de Speakeasy tiene configurada una URL automatizada de muestras de código y al menos un target de SDK habilitado.