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

Insérez une référence API complète à partir de 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 endpoints présents dans votre spécification OpenAPI. Ces pages contiendront des blocs d'opérations OpenAPI, vous permettant, ainsi qu'à vos visiteurs, de tester vos endpoints et de les explorer davantage à partir des informations présentes dans la spécification.

Les endpoints 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 d'endpoints en insérant un Référentiel OpenAPI dans la table des matières d'un Espace.

Insérez 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 d'endpoints, cliquez sur le Ajouter nouveau... bouton depuis le bas de la table des matières.

À partir d'ici, cliquez sur Référentiel 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 endpoints à votre espace. Vous pouvez éventuellement choisir d'ajouter une page de modèles référant toutes vos schémas OpenAPI.

3

Gérez vos opérations d'API

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

Rendez-vous sur Structuration de 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 individuellement des opérations ou des schémas OpenAPI de votre spécification à des pages réparties dans votre documentation.

1

Ajouter un nouveau bloc OpenAPI

Ouvrez le sélecteur de bloc en appuyant sur /, et cherchez 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 endpoints 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.