Si tus usuarios interactúan con tu API mediante un SDK en lugar de hacerlo directamente a través de una solicitud de red, puedes usar la extensión x-codeSamples
para agregar fragmentos 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.
El lenguaje del fragmento de código.
La etiqueta del ejemplo. Es útil cuando se proporcionan varios ejemplos para un mismo endpoint.
El código fuente del ejemplo.
Aquí tienes un ejemplo de fragmentos de código para una app de seguimiento de plantas, que cuenta con una herramienta CLI en Bash y 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 });