Updated RADME.md

This commit is contained in:
2023-10-11 20:52:01 +03:00
parent b52be1a89c
commit 3741f984e9
2 changed files with 7 additions and 21 deletions

View File

@@ -1,18 +1,4 @@
# Parser API
## Описание
FastAPI REST API, предоставляющий доступ к данным с сайта [Россети Ленэнерго](https://rosseti-lenenergo.ru/planned_work/).
## Доступные методы
- GET `/api/list` - Поиск по каждому полю в отдельности
- GET `/api/search` - Поиск по всем полям сразу
- GET `/api/check` - Проверка, является ли отключение в вашем доме сейчас официальным и если да, то когда сеть снова включат.
- PUT `/api/create` - Отладочное поле для добавления записей в БД
- GET `/` - Healthcheck
Подробнее: [Swagger UI](http://localhost:8000/docs) когда запущенно приложение
# Runner
## Инструкция по запуску
@@ -23,5 +9,5 @@ python -m venv .venv
pip install -r requirements.txt
python -m uvicorn parser_api.main:app
python -m runner
```