API表示

開発プロキシ REST API エンドポイントに関する情報を表示します。

概要

devproxy api show [options]

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

Usage

devproxy api show

オプション

氏名 [説明] 使用できる値 既定値
--output <format> 出力形式 text、json text
-?, -h, --help ヘルプと使用状況の情報を表示する なし なし

例示

Dev Proxy API の情報を表示する

devproxy api show

API 情報を JSON として取得する

devproxy api show --output json

注釈

開発プロキシは、http://127.0.0.1:{api-port}の Swagger ドキュメントを使用して、8897 (既定のポート http://127.0.0.1:{api-port}/swagger) で REST API を公開します。

api show コマンドは、使用可能な REST API エンドポイントを一覧表示します。 この API は、開発プロキシの実行中に使用できます。 ライフサイクル操作 (開始、停止、構成) には CLI を使用し、ランタイム操作 (プロキシの状態、記録、モック管理) には REST API を使用します。

次のエンドポイントを使用できます。

メソッド エンドポイント [説明]
GET /proxy プロキシの状態を取得する
POST /proxy プロキシを開始または停止する
POST /proxy/mockRequest モック要求を送信する
POST /proxy/stopProxy プロキシを停止する
POST /proxy/jwtToken JSON Web トークン (JWT) を作成する
GET /proxy/rootCertificate ルート証明書を取得する
GET /proxy/logs 記録された要求ログを取得する

完全な API リファレンスについては、 プロキシ API に関するセクションを参照してください。

  • Last updated on