Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Los fragmentos de código generados automáticamente a partir de los SDK de Speakeasy pueden integrarse directamente en la documentación de referencia de la API de Mintlify. Los fragmentos de uso del SDK se muestran en el área de pruebas interactiva de los sitios de documentación creados con 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:

​
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.

​
Obtener 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. La pestaña API Registry está resaltada con un cuadro rojo y el número 1, y la entrada de la API está resaltada con un cuadro rojo y el número 2.
Si la entrada no está etiquetada como Combined Spec, asegúrate de que la API tenga configurada una URL automática de muestras 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 de copiar URL resaltada con un cuadro 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 anchor actualizando el campo anchor en tu archivo docs.json de la siguiente manera:
docs.json
{
  "anchors": [
    {
      "name": "Referencia de 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 API",
      "url": "api-reference",
      // !mark
      "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
    }
  ]
}
Ahora puedes ver los fragmentos de código generados por Speakeasy en la documentación de tu API e interactuar con ellos en el área de pruebas.