mostra API

Visualizza informazioni sugli endpoint dell'API REST del proxy di sviluppo.

Synopsis

devproxy api show [options]

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

Usage

devproxy api show

Options

Nome Descrzione Valori consentiti Impostazione predefinita
--output <format> Formato di output text, json text
-?, -h, --help Visualizzare informazioni sulla Guida e sull'utilizzo non disponibile non disponibile

Esempi

Visualizzare le informazioni sull'API del proxy di sviluppo

devproxy api show

Ottenere informazioni sull'API come JSON

devproxy api show --output json

Osservazioni:

Dev Proxy espone un'API REST autenticata ( http://{api-ip-address}:{api-port} impostazione predefinita http://127.0.0.1:8897). Tutti gli endpoint richiedono il token di connessione dell'istanza nell'intestazione della Authorization richiesta. Per recuperare il token, usare il comando del token API .

Il api show comando elenca l'URL di base dell'API, i requisiti di autenticazione e gli endpoint DELL'API REST disponibili. Con --output json, include anche il modello di file del token. L'URL di base riflette l'indirizzo e la porta dell'API configurati. Per ottenere l'URL API effettivo di un'istanza in esecuzione, ad esempio quando si usa --api-port 0, usare il comando status . L'API è disponibile durante l'esecuzione del proxy di sviluppo. Usare l'interfaccia della riga di comando per le operazioni del ciclo di vita (avvio, arresto, configurazione) e usare l'API REST per le operazioni di runtime (stato proxy, registrazione, gestione fittizia).

Sono disponibili i seguenti endpoint:

Metodo Punto finale Descrzione
GET /proxy Ottenere lo stato del proxy
POST /proxy Aggiornare lo stato del proxy (ad esempio, avviare o arrestare la registrazione)
POST /proxy/mockRequest Inviare una richiesta fittizia
POST /proxy/stopProxy Arrestare il proxy
POST /proxy/jwtToken Creare un token JSON Web (JWT)
GET /proxy/rootCertificate Ottenere il certificato radice
GET /proxy/logs Ottenere i log del proxy di sviluppo (solo modalità scollegata)

Per informazioni di riferimento sull'API completa, vedere API proxy.

  • Ultimo aggiornamento: