OpenAPI

Ajoutez une spécification OpenAPI à une page et permettez à vos utilisateurs de tester les points de terminaison directement sur la page grâce à des blocs interactifs.

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 l’ensemble de 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 vos méthodes d’API, que la spécification soit fournie sous forme de fichier ou chargée depuis une URL.

GitBook prend en charge Swagger 2.0 ou OpenAPI 3.0 fichiers conformes.

Add a new pet to the store.

post

Add a new pet to the store.

Scopes requis

Cet endpoint nécessite les scopes suivants:

• : modify pets in your account
• : read your pets

Autorisations

petstore_auth

OAuth2implicitRequis

Authorization URL:

Corps

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64OptionnelExample: 10

namestringRequisExample: doggie

photoUrlsstring[]Requis

statusstring · enumOptionnel

pet status in the store

Valeurs possibles:

Réponses

200

Successful operation

application/jsonapplication/xml

idinteger · int64OptionnelExample: 10

namestringRequisExample: doggie

photoUrlsstring[]Requis

statusstring · enumOptionnel

pet status in the store

Valeurs possibles:

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

application/jsonapplication/xmlapplication/x-www-form-urlencoded

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Le tester (alimenté par Scalar)

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

Propulsé par Scalar, vous n’aurez pas besoin de quitter la documentation pour voir vos méthodes d’API en action. Voir un exemple ci-dessus.

FAQ

Pourquoi ma spécification ne se charge-t-elle pas ?

Remarque : Ces informations s’appliquent uniquement aux spécifications ajoutées par URL.

Si vous avez ajouté votre spécification via une URL, votre API doit autoriser les requêtes interorigines 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 exemple, 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 : *