API 節目

顯示 Dev Proxy REST API 端點的資訊。

概要

devproxy api show [options]

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

Usage

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

備註

Dev Proxy 會暴露一個已認證的 REST API http://{api-ip-address}:{api-port} （預設 http://127.0.0.1:8897）。 所有端點都要求請求標頭中 Authorization 包含實例承載權杖。 要取得該標記，請使用 API 標記 指令。

此 api show 指令列出 API 基礎網址、認證要求及可用的 REST API 端點。 其中 --output json，也包含了令牌檔案模式。 基礎網址反映已設定的 API 位址與埠碼。 要取得執行實例的實際 API URL，例如當你使用 --api-port 0時，可以使用 status 指令。 API 在 Dev Proxy 執行時即可使用。 生命週期操作（啟動、停止、設定）使用 CLI，執行時操作（代理狀態、記錄、模擬管理）則使用 REST API。

下列端點可供使用：

方法	端點	Description
GET	/proxy	取得代理權
POST	/proxy	更新代理狀態（例如開始或停止錄影）
POST	/proxy/mockRequest	發送模擬請求
POST	/proxy/stopProxy	停止代理
POST	/proxy/jwtToken	建立 JSON 網頁令牌（JWT）
GET	/proxy/rootCertificate	取得根憑證
GET	/proxy/logs	取得開發代理日誌（僅限分離模式）

完整 API 參考資料請參見 代理 API。