API и интеграции

Этот раздел собирает все публичные технические контракты Remnawave Minishop: HTTP API Mini App и админки, доменные события и API Python-плагинов.

Быстрый старт

• Интерактивная спецификация показывает текущий OpenAPI-контракт через Swagger UI. Она читает опубликованный /openapi.json.
• HTTP-контракты описывают envelope ответов, авторизацию, пагинацию, не-JSON маршруты и правила typed route contracts.
• Доменные события фиксируют payload-модели, event names и core-реакции.
• API плагинов и контракт плагинов описывают расширение проекта без форка ядра.

Источник правды

Машиночитаемый контракт HTTP API хранится в docs/openapi.json, а на сайте публикуется как /openapi.json. Файл генерируется из живого aiohttp-роутера и проверяется контрактными тестами, поэтому его нельзя править руками.

После изменения HTTP-контракта регенерируйте артефакты:

PYTHONPATH=backend python -m bot.app.web.openapi
npm --prefix frontend run generate:api-types

Swagger UI на сайте - это только удобная витрина поверх openapi.json. Контрактом остаются backend route contracts, сгенерированный OpenAPI-файл и проверки drift-guard.