Programa API

Apresenta informações sobre os endpoints 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	Description	Valores permitidos	Predefinido
--output <format>	Formato de saída	text, json	text
-?, -h, --help	Mostrar ajuda e informação de utilização	não aplicável	não aplicável

Exemplos

Mostrar informação da API do Proxy de Desenvolvimento

devproxy api show

Obtenha informação da API em 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} (por defeito http://127.0.0.1:8897). Todos os endpoints requerem o token portador da instância no Authorization cabeçalho do pedido. Para recuperar o token, use o comando API token .

O api show comando lista a URL base da API, os requisitos de autenticação e os endpoints disponíveis da API REST. Com --output json, inclui também o padrão do ficheiro token. A URL base reflete o endereço e a porta da API configurados. Para obter a URL real da API de uma instância em execução, por exemplo, quando usar --api-port 0, use o comando status . A API está disponível enquanto o Dev Proxy está a correr. Use a CLI para operações do ciclo de vida (iniciar, parar, configurar) e utilize a API REST para operações em tempo de execução (estado proxy, gravação, gestão de mocks).

Estão disponíveis os seguintes parâmetros:

Método	Ponto final	Description
GET	/proxy	Obtenha o estatuto de procuração
POST	/proxy	Atualizar o estado do proxy (por exemplo, iniciar ou parar a gravação)
POST	/proxy/mockRequest	Envie um pedido simulado
POST	/proxy/stopProxy	Parem o procurador
POST	/proxy/jwtToken	Criar um Token Web JSON (JWT)
GET	/proxy/rootCertificate	Obtenha o certificado raiz
GET	/proxy/logs	Obter registos de Proxy de Desenvolvimento (apenas modo destacado)

Para a referência completa da API, veja Proxy API.