> For the complete documentation index, see [llms.txt](https://gitbook.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook.com/docs/documentation/fr/creer-du-contenu/openapi/guides/adding-custom-code-samples.md).

# Ajouter des exemples de code personnalisés

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 manière dont vos points de terminaison sont présentés et pouvez proposer des exemples spécifiques à un langage ou à un SDK.

{% code title="openapi.yaml" %}

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

{% endcode %}

**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).
  * `libellé`: Un court libellé pour le bloc de code.
  * `source`: L'extrait de code réel.

### Guide rapide

<details>

<summary>Comment ajouter des exemples de code personnalisés depuis Fern ?</summary>

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, la mise en forme `x-codeSamples`, et leur ajout à une opération d'API.

<button type="button" class="button secondary" data-action="ask" data-query="How do I add custom code samples from Fern to my GitBook API documentation? Show me how to find Fern-generated SDK examples, format x-codeSamples, and add them to an OpenAPI operation. Include links to the relevant docs pages." data-icon="gitbook-assistant">Ouvrir le guide</button>

</details>

<details>

<summary>Comment ajouter des exemples de code personnalisés depuis Stainless ?</summary>

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, la mise en forme `x-codeSamples`, et leur ajout à une opération d'API.

<button type="button" class="button secondary" data-action="ask" data-query="How do I add custom code samples from Stainless to my GitBook API documentation? Show me how to find Stainless-generated SDK examples, format x-codeSamples, and add them to an OpenAPI operation. Include links to the relevant docs pages." data-icon="gitbook-assistant">Ouvrir le guide</button>

</details>

<details>

<summary>Comment ajouter des exemples de code personnalisés depuis HeyAPI ?</summary>

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, la mise en forme `x-codeSamples`, et leur ajout à une opération d'API.

<button type="button" class="button secondary" data-action="ask" data-query="How do I add custom code samples from HeyAPI to my GitBook API documentation? Show me how to find HeyAPI-generated SDK examples, format x-codeSamples, and add them to an OpenAPI operation. Include links to the relevant docs pages." data-icon="gitbook-assistant">Ouvrir le guide</button>

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://gitbook.com/docs/documentation/fr/creer-du-contenu/openapi/guides/adding-custom-code-samples.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.