Passer au contenu principal

Documentation Index

Fetch the complete documentation index at: https://omer-914cc1c6.mintlify.app/llms.txt

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

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 suit le schéma suivant.
​
lang
string
requis
La langue de l’extrait de code.
​
label
string
Le label de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même point de terminaison.
​
source
string
requis
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 Bash en interface en ligne de commande (CLI) et un SDK JavaScript. 
paths:
  /plants:
    get:
      # ...
      x-codeSamples:
        - lang: bash
          label: Lister toutes les plantes non arrosées
          source: |
            planter list -u
        - lang: javascript
          label: Lister toutes les plantes non arrosées
          source: |
            const planter = require('planter');
            planter.list({ unwatered: true });
        - lang: bash
          label: Lister toutes les plantes en pot
          source: |
            planter list -p
        - lang: javascript
          label: Lister toutes les plantes en pot
          source: |
            const planter = require('planter');
            planter.list({ potted: true });