# Insérer une référence d'API dans votre documentation

GitBook vous permet de générer automatiquement des pages liées aux endpoints que vous avez dans votre spécification OpenAPI. Ces pages contiendront des blocs d’opérations OpenAPI, vous permettant, ainsi qu’à vos visiteurs, de tester vos endpoints et de les explorer plus en détail à partir des informations trouvées dans la spécification.

{% hint style="success" %}
Les endpoints ajoutés depuis votre spécification continueront d’être mis à jour chaque fois que votre spécification sera mise à jour. Consultez la [Mettre à jour votre spécification](/docs/documentation/fr/api-references/openapi/add-an-openapi-specification.md#update-your-specification) section pour plus d’informations.
{% endhint %}

### Créer automatiquement des pages OpenAPI à partir de votre spécification

Après avoir [ajouté votre spécification OpenAPI](/docs/documentation/fr/api-references/openapi/add-an-openapi-specification.md), vous pouvez générer des pages d’endpoint en insérant une **référence OpenAPI** dans la table des matières d’un espace.

<figure><img src="/files/8c4b2e10bda82bf80caa71b1f1a8d83b0071af95" alt="A GitBook screenshot showing how to insert API references into the table of contents of a space"><figcaption><p>Insérez des références API dans la table des matières d’un espace.</p></figcaption></figure>

{% stepper %}
{% step %}
**Générer des pages à partir d’OpenAPI**

Dans l’espace dans lequel vous souhaitez générer des pages d’endpoint, cliquez sur le **Ajouter un nouveau...** bouton en bas de la [table des matières](/docs/documentation/fr/ressources/gitbook-ui.md#table-of-contents).

À partir d’ici, cliquez sur **référence OpenAPI**.
{% endstep %}

{% step %}
**Choisissez votre spécification OpenAPI**

Choisissez votre spécification OpenAPI précédemment téléversée, puis cliquez sur **Insérer** pour ajouter automatiquement vos endpoints à votre espace. Vous pouvez éventuellement choisir d’ajouter une page de modèles faisant référence à tous vos schémas OpenAPI.
{% endstep %}

{% step %}
**Gérez vos opérations d’API**

GitBook générera automatiquement des pages à partir de votre spécification OpenAPI et des balises définies dans sa définition.

Accédez à [Structurer votre référence d'API](/docs/documentation/fr/api-references/guides/structuring-your-api-reference.md) pour en savoir plus sur l’organisation de vos opérations via votre spécification OpenAPI.
{% endstep %}
{% endstepper %}

### Ajouter un bloc OpenAPI individuel

Vous pouvez également ajouter individuellement à des pages, dans toute votre documentation, des opérations OpenAPI ou des schémas issus de votre spécification.

{% stepper %}
{% step %}
**Ajouter un nouveau bloc OpenAPI**

Ouvrez le sélecteur de blocs en appuyant sur **/**, puis recherchez OpenAPI.
{% endstep %}

{% step %}
**Choisissez votre spécification OpenAPI**

Choisissez votre spécification OpenAPI précédemment téléversée, puis cliquez sur **Continuer** pour choisir les endpoints que vous souhaitez utiliser.
{% endstep %}

{% step %}
**Choisissez les opérations ou les schémas que vous souhaitez insérer**

Sélectionnez les opérations et les schémas que vous voulez insérer dans votre documentation, puis cliquez sur **Insérer**.
{% endstep %}
{% endstepper %}


---

# Agent Instructions: 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:

```
GET https://gitbook.com/docs/documentation/fr/api-references/openapi/insert-api-reference-in-your-docs.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.
