Ajouter des exemples de code personnalisés

Découvrez comment configurer des exemples de code personnalisés à afficher avec vos endpoints API

GitBook peut générer automatiquement des exemples de code génériques pour chaque opération d’API. Si vous préférez mettre en avant des extraits personnalisés ou plus détaillés, ajoutez x-codeSamples à votre définition OpenAPI. Ainsi, vous contrôlez la façon dont vos points de terminaison sont présentés et pouvez proposer des exemples spécifiques à un langage ou à un SDK.

openapi.yaml

paths:
  /users :
    get:
      summary: Récupérer les utilisateurs
      x-codeSamples:
        - lang: JavaScript
          label: SDK Node
          source: |
            import { createAPIClient } from 'my-api-sdk';

            const client = createAPIClient({ apiKey: 'my-api-key' });
            client.users.list().then(users => {
              console.log(users);
            });
        - lang: Java
          label: SDK Java
          source: |
            MyApiClient client = new MyApiClient("my-api-key");
            List<User> users = client.getUsers();
            System.out.println(users);

Points clés

• x-codeSamples est un tableau d’objets d’exemple de code.
• Chaque objet définit :

  • lang: La langue du code (par ex. JavaScript, Java).
  • libellé: Une courte étiquette pour le bloc de code.
  • source: L’extrait de code réel.

Guide rapide

Comment ajouter des exemples de code personnalisés depuis Fern ?

Utilisez les exemples de SDK générés par Fern comme exemples de code personnalisés dans votre définition OpenAPI.

Ce guide couvre la recherche des exemples générés, le formatage x-codeSamples, et leur ajout à une opération d’API.

Comment ajouter des exemples de code personnalisés depuis Stainless ?

Utilisez les exemples de SDK générés par Stainless comme exemples de code personnalisés dans votre définition OpenAPI.

Ce guide couvre la recherche des exemples générés, le formatage x-codeSamples, et leur ajout à une opération d’API.

Comment ajouter des exemples de code personnalisés depuis HeyAPI ?

Utilisez les exemples de SDK générés par HeyAPI comme exemples de code personnalisés dans votre définition OpenAPI.

Ce guide couvre la recherche des exemples générés, le formatage x-codeSamples, et leur ajout à une opération d’API.