Skip to main content
Si vos utilisateurs interagissent avec votre API à l’aide d’un SDK plutôt que directement via 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. Ajoutez cette propriété à n’importe quelle méthode de requête. Elle a le schéma suivant.
string
requis
La langue de l’extrait de code.
string
Le libellé de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même endpoint.
string
requis
Le code source de l’exemple.
Voici un exemple d’extraits de code pour une application de suivi de plantes, qui propose à la fois un outil CLI Bash et un SDK JavaScript.