API zobrazit

Zobrazí informace o koncových bodech rozhraní REST API služby Dev Proxy.

Synopse

devproxy api show [options]

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

Využití

devproxy api show

Možnosti

Název Description Povolené hodnoty Výchozí
--output <format> Výstupní formát text, json text
-?, -h, --help Zobrazení informací o nápovědě a využití není k dispozici není k dispozici

Příklady

Zobrazení informací o rozhraní DEV Proxy API

devproxy api show

Získání informací o rozhraní API ve formátu JSON

devproxy api show --output json

Poznámky

Dev Proxy zveřejňuje rozhraní REST API na http://127.0.0.1:{api-port} (výchozí port 8897) s dokumentací Swaggeru na adrese http://127.0.0.1:{api-port}/swagger.

Příkaz api show zobrazí seznam dostupných koncových bodů rozhraní REST API. Rozhraní API je dostupné, když běží dev proxy server. Použijte rozhraní příkazového řádku pro operace životního cyklu (spuštění, zastavení, konfigurace) a rozhraní REST API pro operace za běhu (stav proxy serveru, záznam, napodobení správy).

K dispozici jsou následující koncové body:

Metoda Endpoint Description
GET /proxy Získání stavu proxy serveru
POST /proxy Spuštění nebo zastavení proxy serveru
POST /proxy/mockRequest Odeslání napodobení požadavku
POST /proxy/stopProxy Zastavení proxy serveru
POST /proxy/jwtToken Vytvoření webového tokenu JSON (JWT)
GET /proxy/rootCertificate Získání kořenového certifikátu
GET /proxy/logs Získání zaznamenaných protokolů požadavků

Úplné referenční informace k rozhraní API najdete v tématu Proxy API.

  • Last updated on