Si vos utilisateurs interagissent avec votre API via un SDK plutôt que directement par une requête réseau, vous pouvez utiliser l’extension x-codeSamples
pour ajouter des extraits de code à votre document OpenAPI et les afficher dans vos pages OpenAPI.
Cette propriété peut être ajoutée à n’importe quelle méthode de requête et a le schéma suivant.
La langue de l’extrait de code.
Le libellé de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même endpoint.
Le code source de l’exemple.
Voici un exemple d’extraits de code pour une application de suivi des plantes, qui propose à la fois un outil CLI Bash et 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 });