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 authentifizierte REST-API unter http://{api-ip-address}:{api-port} (Standardeinstellung http://127.0.0.1:8897) verfügbar. Alle Endpunkte erfordern das Instanz bearertoken im Authorization Anforderungsheader. Verwenden Sie den API-Tokenbefehl , um das Token abzurufen.

Der api show Befehl listet die API-Basis-URL, die Authentifizierungsanforderungen und die verfügbaren REST-API-Endpunkte auf. Außerdem --output jsonenthält es das Tokendateimuster. Die Basis-URL spiegelt die konfigurierte API-Adresse und den Port wider. Um die tatsächliche API-URL einer ausgeführten Instanz abzurufen, z. B. bei Verwendung --api-port 0, verwenden Sie den Statusbefehl . 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	Proxystatus aktualisieren (z. B. Starten oder Beenden der Aufzeichnung)
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	Dev Proxy-Protokolle abrufen (nur getrennter Modus)

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