Se gli utenti interagiscono con la tua API tramite un SDK invece che direttamente con una richiesta di rete, puoi usare l’estensione x-codeSamples per aggiungere esempi di codice al documento OpenAPI e visualizzarli nelle pagine OpenAPI. Questa proprietà può essere aggiunta a qualsiasi metodo di richiesta e ha il seguente schema.
lang
string
required
Il linguaggio dell’esempio di codice.
label
string
L’etichetta dell’esempio. È utile quando si forniscono più esempi per un singolo endpoint.
source
string
required
Il codice sorgente dell’esempio.
Di seguito un esempio di esempi di codice per un’app di monitoraggio delle piante, che include sia uno strumento CLI Bash sia un SDK 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 });