ForHosting KIT · Entwickler-Tools

OpenAPI-Pfadparameter in Vorlagenreihenfolge extrahieren

OpenAPI-Pfadvorlagen setzen variable Segmente in geschweifte Klammern. Dokumentationsgeneratoren, Request-Builder, Testdaten und Codegeneratoren benötigen diese Namen jedoch oft als geordnete Liste.

● BetaKostenlos · im Browser
Nutzen Sie es über WebAPIE-MailTelegramApp bald

Diese Funktion durchsucht eine Vorlage von links nach rechts, gibt jeden Pfadparameter an seiner ursprünglichen Stelle zurück und weist ungepaarte öffnende oder schließende Klammern zurück. Sie arbeitet deterministisch und ohne Netzwerkzugriff. Identische Eingaben liefern daher stets dasselbe Ergebnis, was sich für Build-Skripte, Validierungsschritte, Editoren und automatisierte API-Abläufe eignet.

Wandeln Sie eine Pfadvorlage in eine geordnete Liste um

Eine OpenAPI-Operation kann einen Pfad wie <code>/users/{id}/posts/{postId}</code> verwenden, während die umgebenden Werkzeuge die Namen <code>id</code> und <code>postId</code> als getrennte Werte benötigen. Der Extraktor liest die Vorlage vom ersten bis zum letzten Zeichen und gibt die Parameter in genau dieser Reihenfolge zurück. Die Reihenfolge ist wichtig, weil ein Request-Builder, Mock-Server, Dokumentationsbeispiel oder Testgenerator Werte mit ihren Positionen in der URL verbinden kann. Die Suche sortiert, dedupliziert, benennt oder normalisiert den erfassten Text nicht. Kommt ein Name zweimal vor, steht er auch zweimal im Ergebnis und bildet so die übergebene Vorlage genau ab. Statische Pfadsegmente werden ignoriert; Schrägstriche, Versionsangaben, Satzzeichen und gewöhnlicher Text außerhalb der Klammern erzeugen daher keine zusätzlichen Einträge. Eine Vorlage ohne Segmente in geschweiften Klammern ist gültig und liefert eine leere Liste. Dieses eng abgegrenzte Verhalten sorgt für vorhersehbare Ergebnisse, die sich ohne verborgene Umformungen in eine umfangreichere OpenAPI-Verarbeitung einfügen lassen.

Erkennen Sie fehlerhafte Klammern vor der Weiterverarbeitung

Eine fehlende Klammer kann nachfolgende Arbeit unbemerkt verfälschen. Ein Generator könnte etwa den restlichen Pfad als einzelnen Parameter deuten, oder eine Dokumentationsansicht könnte eine Vorlage anzeigen, die niemals zu einer Anfrage passt. Deshalb weist der Extraktor eine schließende Klammer ohne vorherige Öffnung, eine nie geschlossene öffnende Klammer sowie eine zweite Öffnung vor dem Ende des aktuellen Parameters zurück. Die Fehlermeldung nennt die Position der Klammer, sodass sich ungültige Vorlagen in Build-Protokollen oder interaktiven Werkzeugen schneller untersuchen lassen. Die Prüfung erfolgt im selben linearen Durchlauf wie die Extraktion. Es gibt somit keinen getrennten Parserzustand, der der ausgegebenen Liste widersprechen könnte. Ausgeglichene Vorlagen werden normal verarbeitet, auch wenn sie Namen wiederholen oder keine Parameter enthalten. Die Funktion prüft gezielt die Klammerstruktur; sie validiert weder ein vollständiges OpenAPI-Dokument noch das Vorhandensein deklarierter Parameterobjekte und beurteilt keine Namenskonventionen Ihres Teams. Solche umfassenderen Kontrollen gehören in eine Schema- oder Spezifikationsvalidierung.

Nutzen Sie das Ergebnis in Generatoren, Tests und API-Werkzeugen

Die ausgegebene Liste ist als kleiner, gut kombinierbarer Zwischenwert gedacht. Ein Codegenerator kann sie mit den deklarierten Pfadparametern einer Operation vergleichen, ein Testwerkzeug kann für jeden Namen ein Datenfeld anlegen und eine Request-Oberfläche kann Eingabefelder in Pfadreihenfolge darstellen. Auch ein Linter kann zuerst die Extraktion ausführen und bei fehlerhafter Klammerstruktur sofort abbrechen, damit keine verwirrenden Folgefehler entstehen. Da der Algorithmus lediglich einen deterministischen Zeichendurchlauf verwendet, führt er keine Netzwerkaufrufe aus, speichert keine Eingaben, nutzt keine Zufallswerte und hängt nicht von der aktuellen Uhrzeit ab. Er lässt sich deshalb sicher in der kontinuierlichen Integration wiederholen und anhand der Eingabe zwischenspeichern. Übergeben Sie die Pfadvorlage im Feld <code>text</code> und lesen Sie die geordnete Liste unter <code>parameters</code>. Die API-Ausführung kostet $0.002 pro Anfrage; die Browserversion kann lokal laufen. Diese Funktion extrahiert Namen aus einer einzelnen Vorlage. Sie löst keine Servervariablen auf, ersetzt keine Werte, URL-kodiert keine Segmente und analysiert keine vollständige OpenAPI-Datei in YAML oder JSON.

Operationsdeklarationen prüfen

Vergleichen Sie extrahierte Namen mit deklarierten OpenAPI-Pfadparametern und melden Sie fehlende oder überzählige Deklarationen.

Request-Formulare erstellen

Erzeugen Sie Eingabefelder in derselben Reihenfolge, in der die Variablen in der Pfadvorlage stehen.

API-Tests generieren

Wandeln Sie Pfadvariablen in geordnete Testdatenfelder um, bevor Sie Testwerte in Anfragen einsetzen.

Was gibt diese Funktion zurück?

Sie gibt ein parameters-Array mit jedem in Klammern eingeschlossenen Namen in Leserichtung zurück.

Was geschieht bei einer ungepaarten Klammer?

Die Anfrage schlägt mit einem Eingabefehler fehl, der Öffnung oder Schließung sowie den Index der ungepaarten Klammer nennt.

Werden wiederholte Parameternamen entfernt?

Nein. Wiederholte Namen bleiben erhalten, da die Ausgabe jedes Vorkommen in der Reihenfolge der Vorlage abbildet.

Wird ein vollständiges OpenAPI-Dokument validiert?

Nein. Geprüft werden eine Pfadvorlage und ihre Klammern; YAML, JSON, Operationen und Parameterdeklarationen werden nicht analysiert.

Was kostet eine API-Anfrage?

Jede API-Anfrage kostet $0.002. Die Browserversion kann ausgeführt werden, ohne die Vorlage an einen Server zu senden.

Alles auf dieser Seite ist auch per API verfügbar. Dieser Abschnitt richtet sich an Teams, die es in ihre eigenen Systeme einbinden möchten; alle anderen nutzen einfach das Tool oben.

POSThttps://api.kit.forhosting.com/dev/openapi-path-params-extract

Authentifizierung per Bearer-Token. Ein einziger POST stellt die Aufgabe in die Warteschlange; das Ergebnis erhalten Sie per Webhook oder über einen signierten Link.

curl -X POST https://api.kit.forhosting.com/dev/openapi-path-params-extract \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"/users/{id}/posts/{postId}"}'
{
  "text": "/users/{id}/posts/{postId}"
}
{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "dev.openapi_path_params_extract",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

Die API arbeitet asynchron: Sie erhalten sofort eine task_id. Polling ist mit 1 Anfrage pro Sekunde erlaubt.

pro Anfrage$0.002

Der Preis steht auf der Seite – keine Tokens, keine Credits. Fehlgeschlagene Aufgaben werden nicht berechnet.

HTTPCodeBedeutung
401unauthorizedDer API-Schlüssel fehlt oder ist ungültig – prüfen Sie den Authorization-Header (Bearer).
402insufficient_balanceIhr Guthaben reicht für diese Aufgabe nicht aus – Aufladungen verfallen nicht.
404unknown_typeUnbekannter Aufgabentyp – prüfen Sie das Feld „type“ gegen den Katalog.
429rate_limitedZu viele Anfragen – warten Sie kurz; Polling ist mit 1 Anfrage pro Sekunde erlaubt.

Vollständige KIT-Dokumentation lesen →