API-megjelenítés

A Dev Proxy REST API-végpontjaival kapcsolatos információkat jeleníti meg.

Áttekintés

devproxy api show [options]

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

Usage

devproxy api show

Beállítások

Név Description Megengedett értékek Alapértelmezett
--output <format> Kimeneti formátum text, json text
-?, -h, --help Súgó és használati adatok megjelenítése nincs adat nincs adat

Példák

Dev Proxy API-információk megjelenítése

devproxy api show

API-információk lekérése JSON-ként

devproxy api show --output json

Megjegyzések

A Dev Proxy egy hitelesített REST API-t tesz elérhetővé (alapértelmezetthttp://127.0.0.1:8897).http://{api-ip-address}:{api-port} Minden végponthoz szükség van a példány tulajdonosi jogkivonatára a Authorization kérelem fejlécében. A jogkivonat lekéréséhez használja az API-jogkivonat parancsot.

A api show parancs felsorolja az API alap URL-címét, a hitelesítési követelményeket és az elérhető REST API-végpontokat. Ezzel --output jsonegyütt tartalmazza a jogkivonat fájlmintáját is. Az alap URL-cím a konfigurált API-címet és portot tükrözi. Ha egy futó példány tényleges API-URL-címét szeretné lekérni, például ha használja --api-port 0, használja az állapotparancsot . Az API a Dev Proxy futtatása közben érhető el. Használja a parancssori felületet az életciklus-műveletekhez (indítás, leállítás, konfigurálás), és használja a REST API-t futtatókörnyezeti műveletekhez (proxyállapot, rögzítés, modellkezelés).

A következő végpontok érhetők el:

Metódus Végpont Description
GET /proxy Proxy állapotának lekérése
POST /proxy Proxy állapotának frissítése (például felvétel indítása vagy leállítása)
POST /proxy/mockRequest Makettkérelem küldése
POST /proxy/stopProxy A proxy leállítása
POST /proxy/jwtToken JSON-webjogkivonat létrehozása (JWT)
GET /proxy/rootCertificate A főtanúsítvány lekérése
GET /proxy/logs Fejlesztői proxynaplók lekérése (csak leválasztott mód)

A teljes API-referenciaért tekintse meg a Proxy API-t.