In OpenAPI-Spezifikation exportieren

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Exportieren Sie eine REST-API als OpenAPI-Spezifikation, um sie in ein anderes Webservice-Tool zu importieren.

    Vorbereitungen

    Erforderliche Rolle: web_service_admin, rest_api_explorer oder admin

    Prozedur

    1. Navigieren zu Alle > System-Webservices > REST > REST-API-Explorer.
    2. Wählen Sie die API aus, die Sie exportieren möchten.
      Verwenden Sie diese Auswahlmöglichkeiten beispielsweise, um die Tabellen-API für den Export auszuwählen.
      Feld Wert
      Namespace jetzt
      API-Name Table-API
      API-Version Neueste
    3. Wählen Sie unter der Liste der API-Methoden den Link für das Exportformat aus, das Sie verwenden möchten.
      OptionBezeichnung
      OpenAPI-Spezifikation exportieren (YAML) Formatieren Sie den Export in YAML.
      OpenAPI-Spezifikation exportieren (JSON) Formatieren Sie den Export im JSON-Format.
      Der Browser zeigt ein Fenster an, in dem Sie einen Download-Speicherort auswählen können.
    4. Wählen Sie den Download-Speicherort und den Dateinamen aus.
    5. Speichern Sie die Datei.

    Ergebnisse

    Das System lädt die API im ausgewählten Format herunter.

    Nächste Maßnahme

    Importieren Sie die API in ein Webservices-Tool wie Postman oder Insomlia.