API 보여주기

개발자 프록시 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

API 정보를 JSON으로 가져오기

devproxy api show --output json

비고

개발자 프록시는 인증된 REST API(기본값http://127.0.0.1:8897)를 http://{api-ip-address}:{api-port} 노출합니다. 모든 엔드포인트에는 요청 헤더에 인스턴스 전달자 토큰이 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	JWT(JSON 웹 토큰) 만들기
GET	/proxy/rootCertificate	루트 인증서 가져오기
GET	/proxy/logs	개발자 프록시 로그 가져오기(분리 모드에만 해당)

전체 API 참조는 프록시 API를 참조하세요.