Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sumaro2101/basefastapi
Base Template FastAPI for quick start any project.
https://github.com/sumaro2101/basefastapi
alembic api asychronous caddy celery docker docker-compose fastapi git grafana logging poetry postgresql prometheus rebbitmq sqlalchemy
Last synced: about 1 month ago
JSON representation
Base Template FastAPI for quick start any project.
- Host: GitHub
- URL: https://github.com/sumaro2101/basefastapi
- Owner: sumaro2101
- Created: 2024-11-15T18:57:19.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-21T08:44:10.000Z (about 1 month ago)
- Last Synced: 2024-11-23T06:07:07.694Z (about 1 month ago)
- Topics: alembic, api, asychronous, caddy, celery, docker, docker-compose, fastapi, git, grafana, logging, poetry, postgresql, prometheus, rebbitmq, sqlalchemy
- Language: Python
- Homepage:
- Size: 82 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Title
Данный шаблон был разработан для одной цели - облегчения и повышения качества
выполненых тестовых заданий в рамках **FastAPI**.
# Quick start
Для тех кто уже знаком с реализацией и всеми деталями - могут приступить к установке.
## Enviroments
Необходимо заполнить **.env.sample** и в последствии перемеиновать его в **.env**
```python
# .env.sample
POSTGRES_PASSWORD=password # Пароль от базы данных (Настройка)
DB_PASSWORD=password # Пароль от базы данных (Использование)
TEST_POSTGRES_PASSWORD=password # Пароль от тестовой базы данный (Настройка)
TEST_DB_PASSWORD=password # Пароль от тестовой базы данных (Использование)
```
## Docker
Шаблон находится под системой управления и контеризации - **Docker**.
Если у вас нет Docker - вы можете установить его с официального сайта: [Docker](https://www.docker.com/get-started/)
- Вам необходимо сделать "Билд"
```bash
docker compose build
```
- Вам необходимо запустить окружение
```bash
docker compose up
```
- После успешного запуска приложение будет доступно по адрессу: http://localhost:8080
- Grafana: http://localhost:3000
- Flower: http://localhost:5555
# View
Обзор и детали данного шаблона
## Найболее используемые
Найболее используемые конструкции с которыми приходится часто взаимодействовать.
### Registration Routers
- В каждом приложений необходимо инициализировать router
```python
# api/users/views.py
from fastapi import APIRouter
router = APIRouter(
prefix='/users',
tags=['Users'],
)
```
- Затем зарегистрировать роутер
```python
# api_v1/routers.py
from api_v1.users.views import router as users
from config import settings
# В этой функции нужно по порядку регистрировать routers
def register_routers(app: FastAPI) -> None:
app.include_router(
router=users,
prefix=settings.API_PREFIX,
)
```
После регистрации данные маршруты будут доступны.
### Registration Logs
- Логи захватывают все исключения возникшие в системе
и с помошью диспечиризации распределяется по нужным **file.log**
```python
# app_includes/logs_errors.py
from fastapi import FastAPI
from fastapi.responses import JSONResponse
from api_v1.exeptions import ValidationError
# В данной функции регистрируются все исключения для захватывания Логами
def register_errors(app: FastAPI) -> None:
@app.exception_handler(ValidationError)
async def validation_error_handler(
request: Request,
exc: ValidationError,
):
logger.opt(exception=True).warning(exc)
response = dict(
status=False,
error_code=exc.status_code,
message=exc.detail,
)
return JSONResponse(response)
```
- Если вы пишете пользовательское исключение например:
```python
from starlette.exceptions import HTTPException
class ValidationError(HTTPException):
pass
```
То вам нужно его зарегистрировать как было показанно выше,
иначе logs не смогут выявить данное исключение и данные будут утеряны.
### Registration Middlaware
- Для регистрации Middlaware вам нужно добавить его в функцию
```python
from fastapi.middleware.cors import CORSMiddleware
from fastapi import FastAPI
from config import settings
# Данная функция регистрирует все middleware
def register_middlewares(app: FastAPI) -> None:
app.add_middleware(
CORSMiddleware,
allow_origins=[
settings.CURRENT_ORIGIN,
],
allow_credentials=True,
allow_methods=['*'],
allow_headers=['*'],
)
```
- При появлении новых middleware добавляйте их по порядку в эту функцию
### Celery
- Для регистрации task вам нужно создать файл с именем **tasks.py** в вашем приложении:
```python
# api_v1/users/tasks.py
from config import celery_app
import asyncio
@celery_app.task
async def time_sleep_task():
"""
Тестовая задача для Celery
"""
await asyncio.sleep(2.0)
return 'Task is done'
```
- Затем добавить этот файл в список пакетов Celery
```python
# confin.celery.connection.py
app = Celery(__name__)
app.conf.broker_url = settings.rabbit.broker_url
# Регистрация до окружения где находится tasks.py
app.autodiscover_tasks(packages=['api_v1.users'])
```
- После этих действий ваша task будет зарегистрирована
### Test
- Для тестирования у вас есть тестовая база данных, а так же
уже инициализированный отдельный клиент.
Cпособ реализации в **api_v1/tests/conftest.py**
- Что бы написать тестовую функцию которой нужен доступ к API,
вам нужно использовать fixture - client.
> [!NOTE]
> Для асинхронных тестов используйте **@pytest.mark.asyncio**
```python
# api_v1.tests.test_users.py
import pytest
@pytest.mark.asyncio
async def test_get_user_error(client: AsyncClient):
response = await client.get(
'/users/get',
)
assert response.status_code == 400
```
- Для запуска используйте команду
```bash
pytest
```