Accéder au contenu principal Passer au contenu complémentaire

Publier des définitions d'API téléchargeables

Fournissez votre définition d'API en tant que fichier OAS 3.0 ou Swagger 2.0, que vos utilisateur·trices peuvent télécharger depuis votre portail.

Procédure

  1. Dans l'onglet API Portal, cliquez sur le bouton Settings.
  2. Dans la section API DEFINITION DOWNLOAD, sélectionnez les formats dans lesquels vous souhaitez publier votre documentation.
    Boîte de dialogue API Portal settings (Paramètres d'API Portal).
  3. Cliquez sur Back afin de retourner à la liste des API et de publier une version d'API.

Résultats

Une fois votre API publiée et votre potrail déployé, un bouton Download s'affiche. Si vous avez sélectionné un des formats, un bouton Download OAS 3 ou Download Swagger 2 est affiché. Si vous avez sélectionné les deux, une liste déroulante s'affiche, vous permettant de sélectionner le format à télécharger.
L'API Contacts comprend à présent un bouton Download (Télécharger).

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !

Laissez vos commentaires ici