Endpoint Документация

CLI для CI/CD

endpoint-cli запускает коллекции в пайплайнах — аналог Newman. Скачайте бинарник для Linux, Windows или macOS со страницы загрузки (в пакетах deb/rpm он уже есть).

endpoint-cli run ./api -e staging --data users.csv --junit report.xml

Код выхода: 0 — всё прошло, 1 — упавшие тесты или ошибки запросов, 2 — ошибка запуска.

Флаги run

Флаг Описание
-e, --env NAME окружение
--folder PATH запустить только папку
-n, --iterations N число итераций
-d, --data FILE data-файл CSV или JSON
--var KEY=VALUE задать переменную (можно повторять)
--delay MS, --bail, --timeout SEC пауза, остановка на первой ошибке, таймаут
--junit FILE, --json FILE отчёты
-v печатать console.log из скриптов
--proxy URL, --no-proxy-for LIST прокси
--cacert FILE доверенный CA (можно повторять)
--cert FILE --key FILE, --pfx FILE --pfx-pass P клиентский сертификат
--insecure, --no-redirects, --no-cookies TLS, редиректы, cookies
--allow-files-outside файлы в теле вне коллекции

Секреты окружения передаются переменными среды ENDPOINT_VAR_<ИМЯ> (token → ENDPOINT_VAR_TOKEN) или --var token=….

Импорт

endpoint-cli import ./postman_collection.json ./api
endpoint-cli import ./bruno-collection ./api
endpoint-cli import https://api.example.com/openapi.json ./api
endpoint-cli import "https://api.getpostman.com/collections/<uid>" ./api --header "X-Api-Key: PMAK-…"

GitHub Actions

- name: API tests
  env:
    ENDPOINT_VAR_TOKEN: ${{ secrets.API_TOKEN }}
  run: |
    curl -fsSL -o endpoint-cli https://endpoint-dl.ll.kg/latest/endpoint-cli-linux-amd64
    chmod +x endpoint-cli
    ./endpoint-cli run ./api -e ci --junit report.xml

GitLab CI

api-tests:
  image: debian:bookworm-slim
  script:
    - apt-get update && apt-get install -y curl ca-certificates
    - curl -fsSL -o endpoint-cli https://endpoint-dl.ll.kg/latest/endpoint-cli-linux-amd64 && chmod +x endpoint-cli
    - ./endpoint-cli run ./api -e ci --junit report.xml
  artifacts:
    reports:
      junit: report.xml