Intégration avec CI/CD

Apprenez comment automatiser la mise à jour de votre spécification OpenAPI dans GitBook.

GitBook peut fonctionner avec Git Sync ou tout pipeline CI/CD que vous utilisez déjà pour gérer votre spécification OpenAPI. En utilisant le CLI GitBook, vous pouvez automatiser les mises à jour de votre référence API.

Télécharger un fichier de spécification

Si votre spécification OpenAPI est générée lors de votre processus CI, vous pouvez la télécharger directement depuis votre environnement de build :

# Définissez votre jeton API GitBook comme variable d'environnement
export GITBOOK_TOKEN=<api-token>

gitbook openapi publish \
  --spec spec_name \
  --organization organization_id \
  example.openapi.yaml

Définir une nouvelle URL source ou déclencher une actualisation

Si votre spécification OpenAPI est hébergée à une URL, GitBook vérifie automatiquement les mises à jour. Pour forcer une mise à jour (par exemple, après une publication), exécutez :

# Définissez votre jeton API GitBook comme variable d'environnement
export GITBOOK_TOKEN=<api-token>

gitbook openapi publish \
  --spec spec_name \
  --organization organization_id \
  https://api.example.com/openapi.yaml