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

Insérez la référence API complète depuis votre spécification OpenAPI ou choisissez des opérations ou schémas individuels.

GitBook vous permet de générer automatiquement des pages liées aux points de terminaison que vous avez 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 à partir de votre spécification continueront d'être mis à jour chaque fois que votre spécification est mise à jour. Voir la Mettez à jour votre spécification section pour plus d'informations.

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

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

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

1

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

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

À partir d'ici, cliquez sur Référence 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 également choisir d'ajouter une page de modèles faisant référence à tous vos schémas OpenAPI.

3

Gérez vos opérations API

GitBook générera automatiquement des pages en fonction de votre spécification OpenAPI et des balises définies dans sa définition.

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

Ajoutez un bloc OpenAPI individuel

Vous pouvez également ajouter des opérations ou des schémas OpenAPI de votre spécification individuellement aux pages de votre documentation.

1

Ajoutez 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 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.