Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://wiki.another-horizon.eu/llms.txt

Use this file to discover all available pages before exploring further.

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. 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.
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 });