Agregar ejemplos de SDK

Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente mediante 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. Agrega esta propiedad a cualquier método de solicitud. Tiene el siguiente esquema.

string

requerido

El idioma del ejemplo de código.

string

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

string

requerido

El código fuente del ejemplo.

A continuación se muestra un ejemplo de muestras 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: 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 });

Tipos de datos complejos

Gestionar la visibilidad de páginas

⌘I

Primeros pasos

Organizar

Personalizar

Crear contenido

Documentar APIs

Desplegar

Optimizar

Agregar ejemplos de SDK