Ajouter des exemples de SDK

Ajoutez des exemples de code SDK à votre documentation d’API avec des exemples générés automatiquement par Speakeasy et Stainless en plusieurs langages.

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.

langstringrequired

La langue de l’extrait de code.

labelstring

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

sourcestringrequired

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.

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