# OpenAPI

La rédaction manuelle de 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 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.

GitBook prend en charge [Swagger 2.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md) ou [OpenAPI 3.0](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md) conformes.

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

### Testez-le (propulsé par Scalar)

Le bloc OpenAPI de GitBook prend également en charge une fonctionnalité « testez-le », qui permet à vos utilisateurs de tester les méthodes de votre API avec des données et des paramètres préremplis 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 mon spec ne se charge-t-il pas ?</summary>

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

Si vous avez ajouté votre spécification via une URL, votre API doit [autoriser les requêtes](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Access-Control-Allow-Origin) GET cross-origin 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 exemple, `https://your-site.gitbook.io` ou `https://docs.example.com`).\
\
Si votre point de terminaison est सार्वजनिक et n’utilise pas d’identifiants, vous pouvez également renvoyer : `Access-Control-Allow-Origin: *`\ <br>

</details>


---

# 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.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.