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 ověřené rozhraní REST API (http://{api-ip-address}:{api-port}výchozí).http://127.0.0.1:8897 Všechny koncové body vyžadují nosný token instance v Authorization hlavičce požadavku. K načtení tokenu použijte příkaz tokenu rozhraní API .

Tento api show příkaz zobrazí základní adresu URL rozhraní API, požadavky na ověřování a dostupné koncové body rozhraní REST API. Zahrnuje --output jsontaké vzor souboru tokenu. Základní adresa URL odráží nakonfigurovanou adresu a port rozhraní API. Pokud chcete získat skutečnou adresu URL rozhraní API spuštěné instance, například při použití --api-port 0, použijte příkaz stavu . 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	Aktualizace stavu proxy serveru (například spuštění nebo zastavení záznamu)
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í protokolů dev proxy (pouze odpojený režim)

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