Agregar ejemplos de SDK

Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente con una solicitud de red, puedes usar la extensión x-codeSamples para agregar ejemplos de código a tu documento de OpenAPI y mostrarlos en tus páginas de OpenAPI. Esta propiedad se puede agregar a cualquier método de solicitud y tiene el siguiente esquema.

string

requerido

El lenguaje del ejemplo de código.

string

La etiqueta del ejemplo. Es útil cuando proporcionas múltiples ejemplos para un solo endpoint.

string

requerido

El código fuente del ejemplo.

A continuación se muestra un ejemplo de ejemplos de código para una app de seguimiento de plantas, que cuenta con una herramienta de CLI en Bash y un SDK de JavaScript.

paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: Listar todas las plantas sin regar
          source: |
            planter list -u
        - lang: javascript
          label: Listar todas las plantas sin regar
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: Listar todas las plantas en maceta
          source: |
            planter list -p
        - lang: javascript
          label: Listar todas las plantas en maceta
          source: |
            const planter = require('planter');
            planter.list({ potted: true });

Primeros pasos

Configuración principal

Optimización de IA

Componentes

Páginas de API

Autenticación y personalización

Guías

Integraciones

Control de versiones y CI/CD

Agregar ejemplos de SDK