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.

Un área de pruebas de la API de Mintlify con fragmentos de código de Speakeasy.

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.

Captura de pantalla de la página Speakeasy API Registry. Un cuadrado rojo y el número 1 resaltan la pestaña API Registry, y un cuadrado rojo y el número 2 resaltan la entrada 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.

Captura de pantalla que muestra la entrada del registro de la especificación combinada con la función para copiar la URL resaltada con un cuadrado rojo.

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.

Verificar la integración

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.

Segment

Stainless

⌘I

Primeros pasos

Organizar

Personalizar

Crear contenido

Documentar APIs

Desplegar

Optimizar

Requisitos previos

Configurar la integración

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

Actualiza tu archivo de configuración `docs.json`

Verificar la integración

​Requisitos previos

​Configurar la integración

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

​Actualiza tu archivo de configuración docs.json

​Verificar la integración

Requisitos previos

Configurar la integración

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

Actualiza tu archivo de configuración `docs.json`

Verificar la integración