API-visning

Visar information om REST API-slutpunkter för Dev Proxy.

Sammanfattning

devproxy api show [options]

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

Usage

devproxy api show

Alternativ

Namn	Description	Tillåtna värden	Förinställning
--output <format>	Utdataformat	text, json	text
-?, -h, --help	Visa hjälp- och användningsinformation	Inte tillämpligt	Inte tillämpligt

Exempel

Visa dev proxy-API-information

devproxy api show

Hämta API-information som JSON

devproxy api show --output json

Anmärkningar

Dev Proxy exponerar ett autentiserat REST API på http://{api-ip-address}:{api-port} (standard http://127.0.0.1:8897). Alla slutpunkter kräver instansens ägartoken i begärandehuvudet Authorization . Om du vill hämta token använder du api-tokenkommandot .

Kommandot api show visar API-bas-URL:en, autentiseringskrav och tillgängliga REST API-slutpunkter. Med --output jsoninnehåller den även tokenfilmönstret. Bas-URL:en återspeglar den konfigurerade API-adressen och porten. Om du vill hämta den faktiska API-URL:en för en instans som körs, till exempel när du använder --api-port 0, använder du statuskommandot . API:et är tillgängligt när Dev Proxy körs. Använd CLI för livscykelåtgärder (starta, stoppa, konfigurera) och använd REST-API:et för körningsåtgärder (proxytillstånd, inspelning, falsk hantering).

Följande slutpunkter är tillgängliga:

Metod	Endpoint	Description
GET	/proxy	Hämta proxystatus
POST	/proxy	Uppdatera proxystatus (till exempel starta eller stoppa inspelning)
POST	/proxy/mockRequest	Skicka en mock-begäran
POST	/proxy/stopProxy	Stoppa proxyn
POST	/proxy/jwtToken	Skapa en JSON-webbtoken (JWT)
GET	/proxy/rootCertificate	Hämta rotcertifikatet
GET	/proxy/logs	Hämta Dev Proxy-loggar (endast frånkopplat läge)

Fullständig API-referens finns i Proxy-API.