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 en http://127.0.0.1:{api-port} (puerto 8897predeterminado) con la documentación de Swagger en http://127.0.0.1:{api-port}/swagger.

El api show comando enumera los puntos de conexión de la API REST disponibles. 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 Iniciar o detener el proxy
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 Obtención de registros de solicitudes grabadas

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