API mostrar

Muestra información sobre los puntos de conexión de la API REST del proxy de desarrollo.

Sinopsis

devproxy api show [options]

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

Usage

devproxy api show

Options

Nombre	Description	Valores permitidos	Predeterminado
--output <format>	Formato de salida	text, json	text
-?, -h, --help	Mostrar información de ayuda y uso	n/a	n/a

Examples

Mostrar información de la API del proxy de desarrollo

devproxy api show

Obtención de información de API como JSON

devproxy api show --output json

Observaciones

El proxy de desarrollo expone una API REST autenticada en http://{api-ip-address}:{api-port} (valor predeterminado http://127.0.0.1:8897). Todos los puntos de conexión requieren el token de portador de instancia en el encabezado de Authorization solicitud. Para recuperar el token, use el comando de token de API .

El api show comando enumera la dirección URL base de LA API, los requisitos de autenticación y los puntos de conexión de api REST disponibles. Con --output json, también incluye el patrón de archivo de token. La dirección URL base refleja la dirección y el puerto de API configurados. Para obtener la dirección URL real de la API de una instancia en ejecución, por ejemplo, cuando use --api-port 0, use el comando status . La API está disponible mientras se ejecuta el proxy de desarrollo. Use la CLI para las operaciones del ciclo de vida (inicio, detención, configuración) y use la API REST para las operaciones en tiempo de ejecución (estado del proxy, grabación, administración ficticia).

Están disponibles los siguientes puntos de conexión:

Método	Punto final	Description
GET	/proxy	Obtención del estado del proxy
POST	/proxy	Actualizar el estado del proxy (por ejemplo, iniciar o detener la grabación)
POST	/proxy/mockRequest	Envío de una solicitud ficticia
POST	/proxy/stopProxy	Detener el proxy
POST	/proxy/jwtToken	Creación de un token web JSON (JWT)
GET	/proxy/rootCertificate	Obtención del certificado raíz
GET	/proxy/logs	Obtener registros del proxy de desarrollo (solo modo desasociado)

Para obtener la referencia completa de la API, consulte API de proxy.