Exporter vers la spécification OpenAPI

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 1 minute de lecture
  • Exportez une REST API en tant que spécification OpenAPI pour l'importer dans un autre outil de services Web.

    Avant de commencer

    Rôle requis : web_service_admin, rest_api_explorer ou admin

    Procédure

    1. Accédez à la Tout > Services web du système > REST > Explorateur d'API REST.
    2. Sélectionnez l’API que vous souhaitez exporter.
      Par exemple, utilisez ces choix pour sélectionner l’API de table à exporter.
      Champ Valeur
      Espace de noms Maintenant
      Nom d'API API de table
      Version de l'API dernier
    3. Sous la liste des méthodes API, sélectionnez le lien correspondant au format d’exportation que vous souhaitez utiliser.
      OptionDescription
      Exporter la spécification OpenAPI (YAML) Formatez l’exportation au format YAML.
      Exporter la spécification OpenAPI (JSON) Formatez l’exportation au format JSON.
      Le navigateur affiche une fenêtre permettant de sélectionner un emplacement de téléchargement.
    4. Sélectionnez l’emplacement de téléchargement et le nom du fichier.
    5. Enregistrez le fichier.

    Résultats

    Le système télécharge l’API au format que vous avez sélectionné.

    Que faire ensuite

    Importez l’API dans un outil de services Web tel que Postman ou Insomnia.