Insérer une référence API dans vos docs

Insérez une référence API complète à partir de votre spécification OpenAPI ou sélectionnez des opérations ou schémas individuels

GitBook vous permet de générer automatiquement des pages liées aux points de terminaison présents dans votre spécification OpenAPI. Ces pages contiendront des blocs d'opérations OpenAPI, vous permettant, à vous et à vos visiteurs, de tester vos points de terminaison et de les explorer davantage en fonction des informations trouvées dans la spécification.

Les points de terminaison ajoutés depuis votre spécification continueront d'être mis à jour chaque fois que votre spécification sera mise à jour. Voir le Mettez à jour votre spécification section pour plus d'informations.

Créer automatiquement des pages OpenAPI à partir de votre spécification

Après que vous ayez ajouté votre spécification OpenAPI, vous pouvez générer des pages de points de terminaison en insérant un Répertoire OpenAPI dans la table des matières d'un Espace.

Insérer des références d'API dans la table des matières d'un Espace.

1

Générer des pages à partir d'OpenAPI

Dans l'espace où vous souhaitez générer des pages de points de terminaison, cliquez sur le Ajouter un nouveau... bouton en bas de la table des matières.

À partir d'ici, cliquez sur Répertoire OpenAPI.

2

Choisissez votre spécification OpenAPI

Choisissez votre spécification OpenAPI précédemment téléchargée, puis cliquez sur Insérer pour ajouter automatiquement vos points de terminaison à votre espace. Vous pouvez éventuellement choisir d'ajouter une page de modèles référencant tous vos schémas OpenAPI.

3

Gérez vos opérations d'API

GitBook générera automatiquement des pages basées sur votre spécification OpenAPI et les tags définis dans sa définition.

Accédez à Structurer votre référence API pour en savoir plus sur l'organisation de vos opérations via votre spécification OpenAPI.

Ajouter un bloc OpenAPI individuel

Alternativement, vous pouvez ajouter des opérations ou des schémas OpenAPI depuis votre spécification individuellement aux pages de votre documentation.

1

Ajouter un nouveau bloc OpenAPI

Ouvrez le sélecteur de blocs en appuyant sur /, et recherchez OpenAPI.

2

Choisissez votre spécification OpenAPI

Choisissez votre spécification OpenAPI précédemment téléchargée, puis cliquez sur Continuer pour choisir les points de terminaison que vous souhaitez utiliser.

3

Choisissez les opérations ou les schémas que vous souhaitez insérer

Sélectionnez les opérations et les schémas que vous souhaitez insérer dans votre documentation et cliquez sur Insérer.