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 em http://127.0.0.1:{api-port} (porta 8897padrão) com a documentação do Swagger em http://127.0.0.1:{api-port}/swagger.

O api show comando lista os pontos de extremidade da API REST disponíveis. 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 Iniciar ou parar o proxy
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 solicitação registrados

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

  • Last updated on