pokaz interfejsu API

Wyświetla informacje o punktach końcowych interfejsu API REST serwera proxy deweloperów.

Streszczenie

devproxy api show [options]

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

Usage

devproxy api show

Opcje

Name	Opis	Dozwolone wartości	Default
--output <format>	Format wyjściowy	text, json	text
-?, -h, --help	Pokaż informacje pomocy i użycia	n/a	n/a

Przykłady

Pokaż informacje o interfejsie API serwera proxy deweloperów

devproxy api show

Pobieranie informacji o interfejsie API w formacie JSON

devproxy api show --output json

Uwagi

Serwer proxy deweloperów uwidacznia uwierzytelniony interfejs API REST pod adresem http://127.0.0.1:{api-port} (port 8897domyślny). Wszystkie punkty końcowe wymagają tokenu elementu nośnego wystąpienia w nagłówku Authorization żądania. Aby pobrać token, użyj polecenia tokenu interfejsu API .

Polecenie api show wyświetla podstawowy adres URL interfejsu API, wymagania dotyczące uwierzytelniania, wzorzec pliku tokenu i dostępne punkty końcowe interfejsu API REST. Interfejs API jest dostępny, gdy serwer proxy deweloperów jest uruchomiony. Użyj interfejsu wiersza polecenia na potrzeby operacji cyklu życia (uruchamianie, zatrzymywanie, konfigurowanie) i użyj interfejsu API REST na potrzeby operacji środowiska uruchomieniowego (stan serwera proxy, rejestrowanie, pozorowanie zarządzania).

Dostępne są następujące punkty końcowe:

Metoda	Endpoint	Opis
GET	/proxy	Uzyskiwanie stanu serwera proxy
POST	/proxy	Aktualizowanie stanu serwera proxy (na przykład uruchamianie lub zatrzymywanie rejestrowania)
POST	/proxy/mockRequest	Wysyłanie pozornego żądania
POST	/proxy/stopProxy	Zatrzymywanie serwera proxy
POST	/proxy/jwtToken	Tworzenie tokenu internetowego JSON (JWT)
GET	/proxy/rootCertificate	Pobieranie certyfikatu głównego
GET	/proxy/logs	Pobieranie dzienników serwera proxy dev (tylko tryb odłączony)

Aby uzyskać pełną dokumentację interfejsu API, zobacz Interfejs API serwera proxy.