Agregar ejemplos de SDK

Muestra fragmentos de código específicos por idioma junto a tus endpoints de API para enseñar a los desarrolladores cómo usar tus SDK

Si tus usuarios interactúan con tu API mediante un SDK en lugar de directamente a través de 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.

lang · string · requerido

El idioma del ejemplo de código.

label · string

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

source · string · requerido

El código fuente del ejemplo.

Aquí tienes un ejemplo de fragmentos de código para una aplicación de seguimiento de plantas, que incluye tanto una herramienta de CLI en Bash como 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 });