显示有关开发代理 REST API 终结点的信息。
概要
devproxy api show [options]
Options:
--output <format> Output format: text|json (default: text)
-h, --help Show help
用法
devproxy api show
选项
| 姓名 | Description | 允许的值 | 违约 |
|---|---|---|---|
--output <format> |
输出格式 |
text、json |
text |
-?, -h, --help |
显示帮助和使用情况信息 | n/a | n/a |
例子
显示开发代理 API 信息
devproxy api show
以 JSON 形式获取 API 信息
devproxy api show --output json
注解
开发代理在 http://{api-ip-address}:{api-port} (默认 http://127.0.0.1:8897)公开经过身份验证的 REST API。 所有终结点都需要请求标头中的 Authorization 实例持有者令牌。 若要检索令牌,请使用 API 令牌 命令。
该 api show 命令列出了 API 基本 URL、身份验证要求和可用的 REST API 终结点。 此外 --output json,它还包括令牌文件模式。 基 URL 反映配置的 API 地址和端口。 若要获取正在运行实例的实际 API URL,例如使用 --api-port 0时,请使用 状态 命令。 开发代理运行时,该 API 可用。 将 CLI 用于生命周期作(启动、停止、配置),并使用 REST API 进行运行时作(代理状态、记录、模拟管理)。
以下终结点可用:
| 方法 | 端点 | Description |
|---|---|---|
GET |
/proxy |
获取代理状态 |
POST |
/proxy |
更新代理状态(例如启动或停止录制) |
POST |
/proxy/mockRequest |
发送模拟请求 |
POST |
/proxy/stopProxy |
停止代理 |
POST |
/proxy/jwtToken |
创建 JSON Web 令牌 (JWT) |
GET |
/proxy/rootCertificate |
获取根证书 |
GET |
/proxy/logs |
获取开发代理日志(仅分离模式) |
有关完整的 API 参考,请参阅 代理 API。