Ajouter une spécification OpenAPI

Apprenez comment ajouter et mettre à jour une spécification OpenAPI dans l'application GitBook ou depuis le CLI

Si vous avez une spécification OpenAPI, vous pouvez l'ajouter à votre organisation en téléchargeant le fichier directement, en liant une URL hébergée ou en utilisant le GitBook CLI.

Comment ajouter une spécification

1. Ouvrez le OpenAPI section dans la barre latérale

2. Cliquez sur Ajouter une spécification

3. Donnez un nom à votre spécification. Cela aide à l'identifier, surtout si vous gérez plusieurs spécifications

4. Choisissez l'une des options suivantes :

   • Télécharger un fichier (par ex. openapi.yaml)

   • Saisir une URL vers une spécification hébergée

   • Utiliser le CLI pour publier la spécification

Fenêtre modale d'ajout d'une spécification OpenAPI.

Mettez à jour votre spécification

Vous pouvez mettre à jour votre spécification OpenAPI à tout moment en utilisant l'interface GitBook ou le CLI, indépendamment de la façon dont elle a été ajoutée initialement.

Dans l'application GitBook

Dans le panneau OpenAPI :

• Si votre spécification est liée à une URL :

  • GitBook vérifie les mises à jour automatiquement toutes les 6 heures.

  • Pour récupérer les mises à jour immédiatement, cliquez sur Vérifier les mises à jour.

• Si votre spécification a été téléchargée en tant que fichier :

  • Cliquez sur Mettre à jour pour téléverser une nouvelle version.

• Vous pouvez passer d'une source Fichier à une source URL en cliquant sur Modifier dans le menu d'actions du fil d'Ariane.

Utilisation du CLI

Utilisez la même commande pour mettre à jour votre spécification :

gitbook openapi publish --spec api-spec-name --organization organization_id <chemin-ou-url>

Vous pouvez également utiliser le CLI pour Vérifier les mises à jour en exécutant la commande publish sur la même URL.

Lisez notre Intégration avec CI/CD guide pour apprendre comment automatiser la mise à jour de votre spécification.