> 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/api-references/openapi.md).

# OpenAPI

Rédiger manuellement la documentation d’une API REST peut être un processus chronophage. Heureusement, GitBook simplifie cette tâche en vous permettant d’importer des documents OpenAPI, qui détaillent la structure et les fonctionnalités de votre API.

La spécification OpenAPI (OAS) est un cadre que les développeurs utilisent pour documenter les API REST. Rédigée en JSON ou en YAML, elle décrit tous vos points de terminaison, paramètres, schémas et mécanismes d’authentification.

Une fois importés dans GitBook, ces documents sont transformés en blocs d’API interactifs et testables qui représentent visuellement les méthodes de votre API — que la spécification soit fournie sous forme de fichier ou chargée depuis une URL.

### Compatibilité OpenAPI

GitBook prend en charge l’importation et le rendu des versions de spécification suivantes :

* [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) — pris en charge.
* [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) — pris en charge.
* [OpenAPI 3.1](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md) — pris en charge, y compris les fonctionnalités propres à OpenAPI 3.1 telles que `les webhooks`.

{% openapi src="<https://petstore3.swagger.io/api/v3/openapi.json>" path="/pet" method="post" %}
<https://petstore3.swagger.io/api/v3/openapi.json>
{% endopenapi %}

### Tester (propulsé par Scalar)

Le bloc OpenAPI de GitBook prend également en charge la fonctionnalité « tester », qui permet à vos utilisateurs de tester vos méthodes d’API avec des données et des paramètres renseignés depuis l’éditeur.

Propulsé par [Scalar](https://scalar.com/), vous n’aurez pas besoin de quitter la documentation pour voir vos méthodes d’API en action. Voir un exemple ci-dessus.

#### FAQ

<details>

<summary>Pourquoi ma spécification ne se charge-t-elle pas ?</summary>

{% hint style="info" %}
**Remarque :** Ces informations ne s’appliquent qu’aux **spécifications ajoutées par URL**.
{% endhint %}

Si vous avez ajouté votre spécification via URL, votre API doit [autoriser les requêtes inter-origines](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Allow-Origin) GET depuis votre site de documentation. Dans les paramètres CORS de votre API, autorisez l’origine exacte où votre documentation est hébergée (par ex. : `https://your-site.gitbook.io` ou `https://docs.example.com`).\
\
Si votre point de terminaison est public et n’utilise pas d’identifiants, vous pouvez également renvoyer : `Access-Control-Allow-Origin: *`\ <br>

</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/api-references/openapi.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.