Bewise Applications

Этот проект представляет собой сервис для обработки заявок пользователей, разработанный с использованием FastAPI, PostgreSQL и Kafka. Сервис позволяет принимать заявки через REST API, сохранять их в базу данных, публиковать информацию о новых заявках в Kafka, а также предоставляет эндпоинт для получения списка заявок с фильтрацией и пагинацией.

Основные функции

• Прием заявок через REST API
• Сохранение заявок в PostgreSQL
• Публикация заявок в Kafka
• Получение списка заявок

Технологии

• FastAPI — фреймворк для создания API.
• PostgreSQL — реляционная база данных для хранения информации о заявках.
• Kafka - логирование и публикация заявок
• Docker — контейнеризация приложения.
• Docker Compose — управление многоконтейнерными приложениями.
• SQLAlchemy — ORM для работы с базой данных.
• Pydantic - валидация данныx

Запуск проекта

Требования

• Установленный Docker и Docker Compose.
• Python 3.11+ (если требуется запуск вне Docker).

Инструкции по запуску с помощью Docker Compose

1. Склонируйте репозиторий:

   git clone https://github.com/nariman079/bewise_application
   cd bewise_application

2. Создайте .env в корне проекта и заполните его переменными окружения:

   DEBUG=1
   
   POSTGRES_USER=bewise_user
   POSTGRES_PASSWORD=bewise_password
   POSTGRES_DB=bewise_application_db
   POSTGRES_HOST=db
   POSTGRES_PORT=5432
   
   ZOOKEEPER_CLIENT_PORT=2181
   ZOOKEEPER_TICK_TIME=2000
   
   KAFKA_BROKER_ID=1
   KAFKA_ZOOKEEPER_CONNECT=zookeeper:2181
   KAFKA_ADVERTISED_LISTENERS=PLAINTEXT://kafka:9092
   KAFKA_LISTENERS=PLAINTEXT://0.0.0.0:9092
   KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR=1
   KAFKA_BROKERCONNECT=kafka:9092

3. Запустите проект с помощью Docker Compose:

   docker compose up --build

Административная панель для Kafka (Kafdrop)

http://localhost:9000

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

http://localhost:8000/docs

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

Создание заявки

POST /api/applications/

Request Data

{
    "user_name": "UserName",
    "description": "Description ",
}

Responses

201

{
    "message": "Заявка создана",
    "data":  {
        "id": 1,
        "user_name": "UserName",
        "description": "Description"
    }
}

Получение заявок

GET /api/applications/

Request query params

{
    "page": 1,
    "size": 20,
    "user_name": null
}

Responses

200

{
    "message": "Заявки получены",
    "data":  [
        {
            "id": 1,
            "user_name": "UserName",
            "description": "Description"
        },
        {
            "id": 2,
            "user_name": "UserName2",
            "description": "Description2"
        }
    ]
}