> 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/insert-api-reference-in-your-docs.md).
# Insérer une référence d’API dans votre documentation
Insérez une référence d’API complète à partir de votre spécification OpenAPI ou sélectionnez des opérations ou des schémas individuels
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 à partir de 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/creer-du-contenu/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/creer-du-contenu/openapi/add-an-openapi-specification.md), vous pouvez générer des pages d’endpoints en insérant une **référence OpenAPI** dans la table des matières d’une section.
Insérez des références API dans la table des matières d’une section.
{% stepper %}
{% step %}
**Générer des pages à partir d’OpenAPI**
Dans la section pour laquelle vous souhaitez générer des pages d’endpoints, cliquez sur le **Ajouter un nouveau...** bouton en bas de la [table des matières de votre section](/docs/documentation/fr/reference/gitbook-ui.md#table-of-contents).
Depuis là, 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 choisissez une **Structure des pages**:
* **Une page par tag**
* **Une page par opération**
Vous pouvez également choisir d’ajouter une page des modèles et un lien de téléchargement. Cliquez sur **Insérer** pour générer la référence.
{% endstep %}
{% step %}
**Gérez vos opérations d’API**
GitBook générera automatiquement des pages à partir de votre spécification OpenAPI et des tags définis dans sa définition. Si vous choisissez **Une page par opération**, GitBook regroupe les pages d’opérations générées par tag.
Rendez-vous dans [les mises en page OpenAPI](/docs/documentation/fr/creer-du-contenu/openapi/guides/openapi-layouts.md) pour comparer les mises en page, ou [Structurer votre référence d’API](/docs/documentation/fr/creer-du-contenu/openapi/guides/structuring-your-api-reference.md) pour organiser les pages avec des tags.
{% endstep %}
{% endstepper %}
### Ajouter un bloc OpenAPI individuel
Vous pouvez également ajouter individuellement des opérations ou des schémas OpenAPI issus de votre spécification à des pages dans l’ensemble de votre documentation.
{% 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 souhaitez insérer dans votre documentation, puis cliquez sur **Insérer**.
{% endstep %}
{% endstepper %}
---
# 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/insert-api-reference-in-your-docs.md?ask=&goal=
```
`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.
