Приложение «Коллекция API»

API Collection — это инструмент для работы со Swagger/OpenAPI спецификациями прямо в бэкенде Webasyst. Сохраняйте коллекции API, выполняйте HTTP-запросы через встроенный прокси и тестируйте endpoints без сторонних инструментов вроде Postman.

Импорт из URL или файла

Загружайте спецификации по ссылке на swagger.json/openapi.json или загружайте JSON-файлы напрямую с диска.

Профили окружения

Создавайте профили Production, Staging, Local для быстрого переключения между серверами без изменения коллекции.

Безопасный прокси

Все запросы к внешним API проходят через серверный прокси с защитой от SSRF и ограничением размера ответа 5 МБ.

История запросов

Сохраняйте историю всех выполненных запросов с параметрами, ответами и статусами для последующего анализа.

Возможности приложения

Два источника спецификаций — ссылка на URL или загрузка JSON-файла с диска
Просмотр дерева endpoints — навигация по тегам и методам API в удобном древовидном интерфейсе
Выполнение HTTP-запросов — GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS прямо из браузера
Аутентификация — поддержка none, bearer, basic, apikey
Произвольные заголовки — добавление кастомных HTTP-заголовков к каждому запросу
Профили окружения — переключение между Production, Staging, Development без редактирования коллекции
Просмотр схемы запроса — для body-параметров отображается JSON Schema и пример структуры
История запросов — полная история с параметрами, ответами и возможностью повторного выполнения
Личные и общие коллекции — делитесь коллекциями с командой или храните приватно
Webasyst UI 2.0 — нативный интерфейс в стиле бэкенда Webasyst

Два способа загрузки спецификаций

Приложение поддерживает два формата источников для Swagger/OpenAPI спецификаций:

URL-источник

Укажите прямую ссылку на swagger.json или openapi.json. Спецификация загружается при каждом обращении к коллекции.

Актуальная версия спецификации
Не занимает место на сервере
Требуется доступность URL

Загрузка файла

Загрузите JSON-файл спецификации напрямую с диска. Файл сохраняется в wa-data/apicollection/specs/.

Работает без доступа к интернету
Для локальных и внутренних API
Максимальный размер — 10 МБ

Профили окружения

Зачем нужны профили? Один API часто развёрнут на нескольких серверах: продакшен, тестовый стенд, локальная разработка. Профили окружения позволяют переключаться между ними без создания дубликатов коллекции.

Для каждой коллекции можно создать несколько профилей окружения:

Production — боевой сервер https://api.example.com
Staging — тестовый стенд https://staging-api.example.com
Local — локальная разработка http://localhost:8080

Каждый профиль хранит:

Base URL — базовый адрес API (переопределяет URL из коллекции)
Аутентификацию — отдельный токен/логин-пароль для каждого окружения
Произвольные заголовки — уникальные заголовки для конкретного окружения

Переключение между профилями происходит в один клик через выпадающий список в панели инструментов.

Просмотр схемы и примера body-параметров

Для endpoints, принимающих данные в теле запроса (POST, PUT, PATCH), приложение автоматически отображает:

Вкладка «Модель»

Описание JSON Schema с типами полей, обязательными параметрами и вложенными объектами. Поддерживаются $ref ссылки на компоненты спецификации.

Вкладка «Пример»

Автоматически сгенерированный пример структуры запроса на основе схемы. Используйте как шаблон для заполнения реальных данных.

Это особенно полезно при работе со сложными вложенными объектами и массивами — вы сразу видите ожидаемую структуру без изучения документации API.

Безопасность и прокси

Все запросы к внешним API выполняются через серверный прокси proxyFetchAction:

Разрешены только http:// и https:// URL
Защита от SSRF-атак встроена
Максимальный размер ответа — 5 МБ (с маркером [TRUNCATED])
Чувствительные заголовки ответа (Server, X-Powered-By) удаляются
История запросов пишется всегда, даже при ошибке

Произвольные заголовки (Custom Headers)

Для случаев, когда требуется несколько методов аутентификации одновременно (например, Basic Auth + API-ключ в заголовке), каждая коллекция поддерживает список произвольных HTTP-заголовков:

[
  { "name": "X-API-Key", "value": "secret123" },
  { "name": "X-Request-ID", "value": "uuid-123" },
  { "name": "X-Tenant-ID", "value": "tenant123" }
]

Заголовки автоматически добавляются ко всем запросам коллекции. Приоритет (последний побеждает):

Заголовки аутентификации
Произвольные заголовки коллекции
Заголовки из текущего запроса (UI)

Технические требования

Webasyst Framework — версия 2.6+
PHP — 7.4+
Браузер — современный браузер с поддержкой ES6+ (Chrome 90+, Firefox 88+, Safari 14+, Edge 90+)
Vue 3 — встроен в сборку приложения (не требуется установка)

Структура базы данных

Приложение создаёт 4 таблицы в БД Webasyst:

apicollection_collection — коллекции спецификаций
apicollection_environment — профили окружения
apicollection_environment_selected — выбранные профили для коллекций
apicollection_request_history — история выполненных запросов

Примеры использования

Разработка интеграций

Тестируйте API сторонних сервисов (платёжные системы, службы доставки, CRM) без переключения между окнами браузера. Сохраняйте коллекции с готовыми настройками аутентификации.

Отладка собственного API

Создайте коллекцию для вашего API на основе Swagger-спецификации. Переключайтесь между Production и Staging окружениями для проверки исправлений.

Командная работа

Поделитесь общей коллекцией с командой разработчиков. Все участники видят историю запросов и могут воспроизвести проблемы.

API Collection — это Postman прямо в бэкенде Webasyst. Импортируйте Swagger/OpenAPI спецификации, выполняйте запросы и отлаживайте интеграции без установки дополнительного софта.

< 10

Syrnik

17 марта 2026

Импорт из URL или файла

Профили окружения

Безопасный прокси

История запросов

Возможности приложения

Два способа загрузки спецификаций

URL-источник

Загрузка файла

Профили окружения

Просмотр схемы и примера body-параметров

Вкладка «Модель»

Вкладка «Пример»

Безопасность и прокси

Произвольные заголовки (Custom Headers)

Технические требования

Структура базы данных

Примеры использования

Разработка интеграций

Отладка собственного API

Командная работа

Syrnik