VoriTools

API-Definitionen erkunden und Anfragecode erzeugen

Fügen Sie die Definition ein, wählen Sie einen Endpunkt und geben Sie Beispielparameter an. Prüfen Sie den Code vor der Ausführung in Ihrem API-Client.

Läuft lokal in deinem Browser
Kategorie ansehen: API-Entwicklung (15)
API-Definition

Fügen Sie ein OpenAPI-3.x- oder Swagger-2.0-Dokument im JSON- oder YAML-Format ein. Dieses Werkzeug lädt nichts hoch und ruft nichts ab.

Verfügbare Operationen
Analysieren Sie eine Definition, um ihre Endpunkte zu durchsuchen.
Anfrage-Generator

Wählen Sie oben einen Endpunkt, um dessen Pfad-, Abfrage-, Header- und Body-Felder zu erstellen.

Select an endpoint to generate a cURL command.
Select an endpoint to generate Fetch code.

Erkunden Sie eine API-Spezifikation, ohne sie irgendwohin zu senden

Der OpenAPI-Explorer liest lokales JSON oder YAML, zeigt Endpunkte und erforderliche Eingaben an und erstellt Anfrage-Snippets, die Sie vor der Nutzung in Ihrem API-Client anpassen können. Er sendet keine Anfragen, Tokens oder Spezifikationen an einen anderen Dienst.

So bauen Sie eine Anfrage aus einer Definition

Fügen Sie eine OpenAPI-3.x- oder Swagger-2.0-Definition ein, um alle deklarierten Operationen aufzulisten, die dokumentierten Parameter auszufüllen und ein cURL- oder Fetch-Snippet für den gewählten Endpunkt zu kopieren.

Definition, Server-URL und Bearer-Token bleiben im Browser. Das Dokument wird lokal ausgewertet, und diese Seite sendet keine Anfrage an Ihre API.

  1. Fügen Sie die Definition als JSON oder YAML in den Editor ein, oder klicken Sie auf Load example, um mit einem Beispiel zu starten.
  2. Klicken Sie auf Analyze definition. Die Operationsliste zeigt Methode und Pfad; fehlt der Versionsmarker oder fehlen Operationen unter paths, sagt die Statuszeile das statt einer Liste.
  3. Wählen Sie eine Operation, um ihr Parameterformular aus der Definition aufzubauen: Felder für Pfad, Query und Header sowie einen Request-Body, wenn die Definition einen beschreibt.
  4. Füllen Sie die Pflichtfelder. Alle dokumentierten Parameter müssen vorhanden sein, bevor Code erzeugt wird; die Statuszeile nennt den ersten, der noch fehlt.
  5. Klicken Sie auf Generate request code und dann auf Copy cURL oder Copy Fetch. Setzen Sie vorher die Server-URL oder ein Bearer-Token, wenn der Endpunkt sie braucht.

Was der Builder tut und was nicht

Welche Definitionen akzeptiert werden

Gelesen werden OpenAPI 3.x und Swagger 2.0, als JSON oder YAML; der Versionsmarker entscheidet, wie Server, Parameter und Request-Bodies interpretiert werden. Ein Dokument ohne beide Marker wird mit einem Hinweis auf das fehlende Wurzelfeld abgelehnt.

Operationszeilen entstehen aus dem paths-Objekt: eine Zeile pro Methode, beschriftet mit Pfad und Operationszusammenfassung, oder mit "No summary provided", wenn die Definition keine Zusammenfassung enthält.

Erzeugte Snippets sind ein Ausgangspunkt

VoriTools schreibt die Anfrage aus der Definition und führt sie nie aus. Diese Seite sendet nichts an Ihre API, ein eingegebenes Token dient also nur dazu, den Snippet-Text zu füllen.

Das Snippet enthält die Parameter und Header, die die Definition dokumentiert. Alles, was sie nicht beschreibt — Wiederholungen, Signierung, Paginierung, OAuth-Abläufe — muss in Ihrem eigenen Client ergänzt werden.

Häufig gestellte Fragen

Ruft dieses Werkzeug meine API auf?

Nein. Es liest die Definition und schreibt Anfragecode; die Anfrage wird hier nie ausgeführt, es gelangt also kein Datenverkehr von dieser Seite an Ihre API.

Welche Definitionsformate werden unterstützt?

OpenAPI 3.x und Swagger 2.0, geschrieben als JSON oder YAML. Der Versionsmarker in der Wurzel des Dokuments bestimmt, wie die einzelnen Felder interpretiert werden.

Zuletzt verwendet: