Files
EvoBGP/docs
..

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

Структурированные материалы по проекту на русском языке. Детальный перечень полей и ответов HTTP API — в openapi.yaml (OpenAPI 3.1).

По роли читателя

Оглавление

Раздел Описание
overview.md Ключевые возможности системы
quickstart.md Быстрый запуск: готовые образы из git.shts.su, Docker Compose, локальный Go, веб
architecture.md Компоненты, потоки данных, пакеты
api.md REST: префикс /v1, публичные маршруты, ссылки на OpenAPI
access.md Выдача доступа: API-ключи, роли, нода, CORS
openapi.yaml Источник правды по контракту API
OPENAPI-GITEA.md Как открыть HTML-документацию API (в т.ч. из Gitea)
evobgp-api-sketches.md Ранний черновик идей API (контекст, не замена OpenAPI)

Репозиторий и CI

  • ../.gitea/README.md — Gitea Actions, runner, сборка образов и push в Container Registry.