API-voorstelling

Geeft informatie weer over de DEV Proxy REST API-eindpunten.

Samenvatting

devproxy api show [options]

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

Usage

devproxy api show

Opties

Naam	Description	Toegestane waarden	Verstek
--output <format>	Uitvoerindeling	text, json	text
-?, -h, --help	Help- en gebruiksgegevens weergeven	n/a	n/a

Voorbeelden

Informatie over de Dev Proxy-API weergeven

devproxy api show

API-gegevens ophalen als JSON

devproxy api show --output json

Opmerkingen

Dev Proxy maakt een geverifieerde REST API beschikbaar ( http://{api-ip-address}:{api-port} standaard http://127.0.0.1:8897). Voor alle eindpunten is het Bearer-exemplaartoken in de Authorization aanvraagheader vereist. Gebruik de opdracht api-token om het token op te halen.

De api show opdracht bevat de API-basis-URL, verificatievereisten en beschikbare REST API-eindpunten. Hiermee --output jsonbevat het ook het tokenbestandspatroon. De basis-URL weerspiegelt het geconfigureerde API-adres en de poort. Gebruik de statusopdracht om de werkelijke API-URL van een actief exemplaar op te halen, bijvoorbeeld wanneer u deze gebruikt--api-port 0. De API is beschikbaar terwijl Dev Proxy wordt uitgevoerd. Gebruik de CLI voor levenscyclusbewerkingen (starten, stoppen, configureren) en gebruik de REST API voor runtimebewerkingen (proxystatus, opname, mock-beheer).

De volgende eindpunten zijn beschikbaar:

Methode	Eindpunt	Description
GET	/proxy	Proxystatus ophalen
POST	/proxy	Proxystatus bijwerken (bijvoorbeeld opname starten of stoppen)
POST	/proxy/mockRequest	Een mock-aanvraag verzenden
POST	/proxy/stopProxy	De proxy stoppen
POST	/proxy/jwtToken	Een JSON-webtoken (JWT) maken
GET	/proxy/rootCertificate	Het basiscertificaat ophalen
GET	/proxy/logs	Dev Proxy-logboeken ophalen (alleen de losgekoppelde modus)

Zie Proxy-API voor de volledige API-verwijzing.