Ajout d’exemples de code personnalisés

Apprenez comment configurer des exemples de code personnalisés à afficher aux côtés de vos endpoints d’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 présenter des extraits personnalisés ou plus détaillés, ajoutez x-codeSamples à votre définition OpenAPI. De cette façon, vous contrôlez la façon dont vos endpoints sont présentés et pouvez offrir 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 : Node SDK
          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 : Java SDK
          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’exemples de code.

• Chaque objet définit :

  • lang: La langue du code (par exemple, JavaScript, Java).

  • label: Un court libellé pour le bloc de code.

  • source: L’extrait de code réel.