API anzeigen

Zeigt Informationen zu den Dev Proxy-REST-API-Endpunkten an.

Zusammenfassung

devproxy api show [options]

Options:
  --output <format>   Output format: text|json (default: text)
  -h, --help          Show help

Verbrauch

devproxy api show

Options

Name Description Zulässige Werte Standard
--output <format> Ausgabeformat text, json text
-?, -h, --help Anzeigen von Hilfe- und Nutzungsinformationen n/a n/a

Beispiele

Anzeigen von Dev-Proxy-API-Informationen

devproxy api show

API-Informationen als JSON abrufen

devproxy api show --output json

Bemerkungen

Dev Proxy macht eine REST-API bei http://127.0.0.1:{api-port} (Standardport 8897) mit Swagger-Dokumentation unter http://127.0.0.1:{api-port}/swagger.

Der api show Befehl listet die verfügbaren REST-API-Endpunkte auf. Die API ist verfügbar, während Dev Proxy ausgeführt wird. Verwenden Sie die CLI für Lebenszyklusvorgänge (Start, Beenden, Konfigurieren) und verwenden Sie die REST-API für Laufzeitvorgänge (Proxystatus, Aufzeichnung, Pseudoverwaltung).

Die folgenden Endpunkte sind verfügbar:

Methode Endpunkt Description
GET /proxy Proxystatus abrufen
POST /proxy Starten oder Beenden des Proxys
POST /proxy/mockRequest Senden einer simulierten Anforderung
POST /proxy/stopProxy Beenden des Proxys
POST /proxy/jwtToken Erstellen eines JSON-Webtokens (JWT)
GET /proxy/rootCertificate Abrufen des Stammzertifikats
GET /proxy/logs Abrufen aufgezeichneter Anforderungsprotokolle

Die vollständige API-Referenz finden Sie unter Proxy-API.

  • Last updated on