27 lines
1.9 KiB
Markdown
27 lines
1.9 KiB
Markdown
# Документация EvoBGP
|
|
|
|
Структурированные материалы по проекту на русском языке. Детальный перечень полей и ответов HTTP API — в [openapi.yaml](openapi.yaml) (OpenAPI 3.1).
|
|
|
|
## По роли читателя
|
|
|
|
- **Оператор / DevOps** — [quickstart.md](quickstart.md), [architecture.md](architecture.md), [access.md](access.md), [deploy/compose/docker-compose.yaml](../deploy/compose/docker-compose.yaml).
|
|
- **Разработчик бэкенда или интегратор API** — [api.md](api.md), [access.md](access.md), [openapi.yaml](openapi.yaml), исходники маршрутов в `internal/httpapi/`.
|
|
- **Разработчик фронтенда** — [quickstart.md](quickstart.md) (раздел про `web/` и CORS), [api.md](api.md), [../web/README.md](../web/README.md).
|
|
|
|
## Оглавление
|
|
|
|
| Раздел | Описание |
|
|
|--------|----------|
|
|
| [overview.md](overview.md) | Ключевые возможности системы |
|
|
| [quickstart.md](quickstart.md) | Быстрый запуск: Docker, локальный Go, веб |
|
|
| [architecture.md](architecture.md) | Компоненты, потоки данных, пакеты |
|
|
| [api.md](api.md) | REST: префикс `/v1`, публичные маршруты, ссылки на OpenAPI |
|
|
| [access.md](access.md) | Выдача доступа: API-ключи, роли, нода, CORS |
|
|
| [openapi.yaml](openapi.yaml) | Источник правды по контракту API |
|
|
| [OPENAPI-GITEA.md](OPENAPI-GITEA.md) | Как открыть HTML-документацию API (в т.ч. из Gitea) |
|
|
| [evobgp-api-sketches.md](evobgp-api-sketches.md) | Ранний черновик идей API (контекст, не замена OpenAPI) |
|
|
|
|
## Репозиторий и CI
|
|
|
|
- [../.gitea/README.md](../.gitea/README.md) — Gitea Actions, требования к runner.
|