показ API

Отображает сведения о конечных точках REST API для прокси-сервера разработки.

Краткие сведения

devproxy api show [options]

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

Usage

devproxy api show

Options

Имя.	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://{api-ip-address}:{api-port} умолчанию http://127.0.0.1:8897. Для всех конечных точек требуется маркер носителя экземпляра в заголовке Authorization запроса. Чтобы получить маркер, используйте команду маркера API .

Команда api show содержит базовый URL-адрес API, требования к проверке подлинности и доступные конечные точки REST API. Кроме --output jsonтого, он включает шаблон файла маркера. Базовый URL-адрес отражает настроенный адрес и порт API. Чтобы получить фактический URL-адрес API запущенного экземпляра, например при использовании --api-port 0, используйте команду состояния . API доступен во время работы прокси-сервера разработки. Используйте CLI для операций жизненного цикла (запуск, остановка, настройка) и использование REST API для операций выполнения (состояние прокси, запись, управление макетами).

Доступны следующие конечные точки:

Метод	Endpoint	Description
GET	/proxy	Получение состояния прокси-сервера
POST	/proxy	Обновление состояния прокси-сервера (например, запуск или остановка записи)
POST	/proxy/mockRequest	Отправка макетного запроса
POST	/proxy/stopProxy	Остановка прокси-сервера
POST	/proxy/jwtToken	Создание веб-маркера JSON (JWT)
GET	/proxy/rootCertificate	Получение корневого сертификата
GET	/proxy/logs	Получение журналов прокси-сервера разработки (только в отключенном режиме)

Полный справочник по API см. в разделе API прокси-сервера.