Agregar ejemplos de SDK

Agrega ejemplos de código de SDK a tu documentación de API con la extensión de OpenAPI x-codeSamples o automáticamente con Speakeasy.

Si tus usuarios interactúan con tu API mediante un SDK en lugar de solicitudes de red directas, agrega ejemplos de código de SDK con la extensión x-codeSamples. Mintlify muestra estos ejemplos en tus páginas de OpenAPI.

Puedes escribir estos ejemplos tú mismo. Si generas tus SDK con Speakeasy, Speakeasy puede agregar los ejemplos a tu especificación automáticamente.

Agregar ejemplos manualmente

Agrega la propiedad x-codeSamples a cualquier método de solicitud. Tiene el siguiente esquema.

langstringrequired

El lenguaje del ejemplo de código.

labelstring

La etiqueta del ejemplo. Es útil cuando se proporcionan varios ejemplos para un mismo endpoint.

sourcestringrequired

El código fuente del ejemplo.

El siguiente ejemplo muestra ejemplos de código para una aplicación de seguimiento de plantas que cuenta tanto con una herramienta CLI de Bash como con un SDK de JavaScript.

paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: List all unwatered plants
          source: |
            planter list -u
        - lang: javascript
          label: List all unwatered plants
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: List all potted plants
          source: |
            planter list -p
        - lang: javascript
          label: List all potted plants
          source: |
            const planter = require('planter');
            planter.list({ potted: true });

Generar ejemplos con Speakeasy

Si generas tus SDK con Speakeasy, puedes incorporar sus fragmentos autogenerados a tu referencia de API en lugar de mantenerlos manualmente. Los fragmentos aparecen en el área de pruebas interactiva junto a tus endpoints.

Obtén la URL de la especificación combinada desde el registro

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

Captura de pantalla de la página API Registry de Speakeasy. Un recuadro rojo y el número 1 destacan la pestaña API Registry, y un recuadro rojo y el número 2 destacan la entrada de la API.

Si la entrada no está etiquetada como Combined Spec, asegúrate de que tu API tenga configurada una URL de ejemplos de código automáticos.

Desde la página de la entrada del 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 destacada con un recuadro rojo.

Agrega la URL de la especificación combinada a tu archivo `docs.json`

Agrega la URL de la especificación combinada a un anchor o a una pestaña en el objeto navigation de tu archivo docs.json.

{
  "navigation": {
    "anchors": [
      {
        "anchor": "API reference",
        "icon": "square-terminal",
        // !mark
        "openapi": "SPEAKEASY_COMBINED_SPEC_URL"
      }
    ]
  }
}

Verifica 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 lenguaje aparecen en el área de pruebas. El conjunto de lenguajes disponibles coincide con los targets de SDK configurados en tu proyecto de Speakeasy.

Si los fragmentos no aparecen, comprueba que:

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

Agregar ejemplos de SDK

Agregar ejemplos manualmente

Generar ejemplos con Speakeasy

On this page