Wenn Ihre Benutzer mit Ihrer API über ein SDK statt direkt per Netzwerkanfrage interagieren, können Sie die Erweiterung x-codeSamples verwenden, um Codebeispiele zu Ihrem OpenAPI-Dokument hinzuzufügen und sie auf Ihren OpenAPI-Seiten anzuzeigen. Diese Eigenschaft kann zu jeder Anfragemethode hinzugefügt werden und hat das folgende Schema.
​
lang
string
required
Die Sprache des Codebeispiels.
​
label
string
Die Bezeichnung für das Beispiel. Dies ist nützlich, wenn Sie mehrere Beispiele für einen einzelnen Endpunkt bereitstellen.
​
source
string
required
Der Quellcode des Beispiels.
Hier ist ein Beispiel für Codebeispiele einer Pflanzen-Tracking-App, die sowohl ein Bash-CLI-Tool als auch ein JavaScript-SDK bietet. 
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 });