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

Télécharger une définition OAS3 de l'API

Vous pouvez télécharger facilement une définition OAS3 de vos API activées.

Dans la tuile API de votre jeu de données, une définition OAS3 de votre API est disponible en tant que fichier json. Avec ce fichier, vous pouvez, par exemple :

  • générer du code supplémentaire,
  • déployer la définition OAS dans une documentation Swagger.

Avant de commencer

Vous avez activé une API dans le jeu de données au moins une fois, avec une configuration valide.

Procédure

  1. Dans la liste des jeux de données, cliquez sur un jeu de données avec une API existante.
  2. Dans la vue d'ensemble du jeu de données, cliquez sur l'onglet API du panneau de gauche.
  3. Dans la tuile API, cliquez sur Download API definition (Télécharger la définition d'API) pour récupérer un fichier json contenant la définition OAS3.

    L'API peut être désactivée ou activée, tant que la configuration est valide.

Résultats

Après avoir parcouru votre système jusqu'à votre emplacement favori pour le fichier, le téléchargement démarre.

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