OpenAPI
Ajoutez une spécification OpenAPI à une page et laissez vos utilisateurs tester les endpoints directement sur la page avec des blocs interactifs.
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 YAML, elle décrit tous vos points de terminaison, paramètres, schémas et schémas d'authentification.
Une fois importés dans GitBook, ces documents sont transformés en blocs 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 à partir d'une URL.
GitBook prend en charge Swagger 2.0 ou OpenAPI 3.0 fichiers conformes.
Add a new pet to the store.
10doggiepet status in the store
Successful operation
Invalid input
Validation exception
Unexpected error
POST /api/v3/pet HTTP/1.1
Host:
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"
}{
"id": 10,
"name": "doggie",
"category": {
"id": 1,
"name": "Dogs"
},
"photoUrls": [
"text"
],
"tags": [
{
"id": 1,
"name": "text"
}
],
"status": "available"
}Tester (propulsé par Scalar)
Le bloc OpenAPI de GitBook prend également en charge une fonctionnalité « 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. Voyez un exemple de cela ci-dessus.
Mis à jour
Ce contenu vous a-t-il été utile ?