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 REST-API på http://127.0.0.1:{api-port} (standardport 8897) med Swagger-dokumentation på http://127.0.0.1:{api-port}/swagger.

Kommandot api show visar de tillgängliga REST API-slutpunkterna. 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 Starta eller stoppa proxyn
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 registrerade begärandeloggar

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

  • Last updated on