Insérer une référence d’API dans votre documentation

Insérez une référence API complète à partir de votre spécification OpenAPI ou sélectionnez une opération ou des 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 plus en détail à partir 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. Consultez la Mettre à jour votre spécification section pour plus d’informations.

Créer 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é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 nouveau... bouton en bas de la table des matières.

À 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 éventuellement 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 basées sur votre spécification OpenAPI et sur les balises définies dans sa définition.

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

Ajouter un bloc OpenAPI individuel

Vous pouvez également ajouter individuellement à vos pages, dans toute votre documentation, des opérations ou des schémas OpenAPI issus de votre spécification.

1

Ajouter un nouveau bloc OpenAPI

Ouvrez le sélecteur de blocs en appuyant sur /, puis 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 voulez insérer dans votre documentation, puis cliquez sur Insérer.