Ajouter des exemples de SDK

Afficher des extraits de code spécifiques à un langage à côté de vos endpoints API pour montrer aux développeurs comment utiliser vos SDK

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 exemples 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’exemple de code.

label · string

Le libellé de l’exemple. Utile lorsque vous fournissez plusieurs exemples pour un même endpoint.

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 CLI Bash 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 });