Generate Sphinx docs in markdown
This commit is contained in:
parent
bc4e9caacb
commit
81ff7959f7
84 changed files with 2873 additions and 29 deletions
27
SRV/docs/_build/markdown/api/config/cors.md
vendored
Normal file
27
SRV/docs/_build/markdown/api/config/cors.md
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# config.cors
|
||||
|
||||
Конфигурация CORS для FastAPI-приложения GONETS.
|
||||
|
||||
Модуль инкапсулирует добавление middleware CORSMiddleware со списком
|
||||
разрешённых источников (origins), характерных для локальной разработки и
|
||||
типовых портов фронтенда (например, Vite/React на 5173/5174, dev‑серверы).
|
||||
|
||||
Использование:
|
||||
: cors_config = CORSMiddlewareConfig(app)
|
||||
cors_config.add_cors_middleware()
|
||||
|
||||
Поведение:
|
||||
: - Разрешены все методы (allow_methods=[“\*”]) и заголовки (allow_headers=[“\*”]).
|
||||
- Разрешены креденшлы (allow_credentials=True) для работы с куками (локаль и др.).
|
||||
- При необходимости список origins можно расширить или параметризовать
|
||||
на основе конфигурационного файла окружения.
|
||||
|
||||
### *class* config.cors.CORSMiddlewareConfig(app: FastAPI)
|
||||
|
||||
Bases: `object`
|
||||
|
||||
Класс для настройки CORS политики в FastAPI
|
||||
|
||||
#### add_cors_middleware() → None
|
||||
|
||||
Добавляем CORS в приложение FastAPI
|
||||
1
SRV/docs/_build/markdown/api/config/init_config.md
vendored
Normal file
1
SRV/docs/_build/markdown/api/config/init_config.md
vendored
Normal file
|
|
@ -0,0 +1 @@
|
|||
# config.init_config
|
||||
28
SRV/docs/_build/markdown/api/config/ports.md
vendored
Normal file
28
SRV/docs/_build/markdown/api/config/ports.md
vendored
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# config.ports
|
||||
|
||||
### *class* config.ports.PortConfig(custom_ports: Dict[int, str] = None)
|
||||
|
||||
Bases: `object`
|
||||
|
||||
Конфигурация известных портов для сетевого анализа.
|
||||
|
||||
Назначение:
|
||||
: Предоставляет сопоставление распространённых портов с человекочитаемыми
|
||||
названиями сервисов для отображения в UI и логах. Поддерживает расширение
|
||||
пользовательским словарём.
|
||||
|
||||
#### get_port_name(port: int) → str
|
||||
|
||||
Возвращает название сервиса для указанного порта.
|
||||
|
||||
* **Parameters:**
|
||||
**port** – Номер порта.
|
||||
* **Returns:**
|
||||
Название сервиса или строка вида ‘Port-<port>’.
|
||||
|
||||
#### get_ports() → List[int]
|
||||
|
||||
Возвращает список всех номеров портов.
|
||||
|
||||
* **Returns:**
|
||||
Список номеров портов.
|
||||
Loading…
Add table
Add a link
Reference in a new issue