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

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

GitBook vous permet de générer automatiquement des pages liées aux endpoints que vous avez 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 plus en détail à partir des informations trouvées dans la spécification.

Les endpoints ajoutés à partir de votre spécification continueront d’être mis à jour chaque fois que votre spécification sera 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 d’endpoints en insérant une référence OpenAPI dans la table des matières d’une section.

Insérez des références API dans la table des matières d’une section.

1

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

Dans la section pour laquelle vous souhaitez générer des pages d’endpoints, cliquez sur le Ajouter un nouveau... bouton en bas de la table des matières de votre section.

Depuis là, cliquez sur référence OpenAPI.

2

Choisissez votre spécification OpenAPI

Choisissez votre spécification OpenAPI précédemment téléversée. Puis choisissez une Structure des pages:

• Une page par tag
• Une page par opération

Vous pouvez également choisir d’ajouter une page des modèles et un lien de téléchargement. Cliquez sur Insérer pour générer la référence.

3

Gérez vos opérations d’API

GitBook générera automatiquement des pages à partir de votre spécification OpenAPI et des tags définis dans sa définition. Si vous choisissez Une page par opération, GitBook regroupe les pages d’opérations générées par tag.

Rendez-vous dans les mises en page OpenAPI pour comparer les mises en page, ou Structurer votre référence d’API pour organiser les pages avec des tags.

Ajouter un bloc OpenAPI individuel

Vous pouvez également ajouter individuellement des opérations ou des schémas OpenAPI issus de votre spécification à des pages dans l’ensemble de votre documentation.

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éversé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, puis cliquez sur Insérer.