API mostrar

Exibe informações sobre os pontos de extremidade da API REST do Proxy de Desenvolvimento.

Sinopse

devproxy api show [options]

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

Usage

devproxy api show

Opções

Nome	DESCRIÇÃO	Valores permitidos	Padrão
--output <format>	Formato da saída	text, json	text
-?, -h, --help	Mostrar informações de ajuda e utilização	n/a	n/a

Exemplos

Mostrar informações da API de Proxy de Desenvolvimento

devproxy api show

Obter informações de API como JSON

devproxy api show --output json

Observações

O Proxy de Desenvolvimento expõe uma API REST autenticada em http://{api-ip-address}:{api-port} (padrão http://127.0.0.1:8897). Todos os pontos de extremidade exigem o token de portador de instância no cabeçalho da solicitação Authorization . Para recuperar o token, use o comando de token de api .

O api show comando lista a URL base da API, os requisitos de autenticação e os pontos de extremidade da API REST disponíveis. Com --output json, ele também inclui o padrão de arquivo de token. A URL base reflete o endereço e a porta da API configurados. Para obter a URL de API real de uma instância em execução, por exemplo, quando você usar --api-port 0, use o comando de status . A API está disponível enquanto o Proxy de Desenvolvimento está em execução. Use a CLI para operações de ciclo de vida (iniciar, parar, configurar) e usar a API REST para operações de runtime (estado proxy, gravação, gerenciamento fictício).

Os seguintes endpoints estão disponíveis:

Método	Ponto final	DESCRIÇÃO
GET	/proxy	Obter o status do proxy
POST	/proxy	Atualizar o status do proxy (por exemplo, iniciar ou parar a gravação)
POST	/proxy/mockRequest	Enviar uma solicitação simulada
POST	/proxy/stopProxy	Parar o proxy
POST	/proxy/jwtToken	Criar um JWT (Token Web JSON)
GET	/proxy/rootCertificate	Obter o certificado raiz
GET	/proxy/logs	Obter logs de Proxy de Desenvolvimento (somente modo desanexado)

Para obter a referência completa da API, consulte a API de Proxy.