# fastapi-study

**Repository Path**: daily_study/fastapi-study

## Basic Information

- **Project Name**: fastapi-study
- **Description**: fastapi-study日常学习
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-09-26
- **Last Updated**: 2024-05-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fastapi-study

#### 1、介绍
这是一个基于 FastAPI 的项目，旨在提供一个高效、易用的 API 服务。该项目使用了最新的技术和架构，可以快速开发和部署。

#### 2、软件架构
```
fastapi-study
│     
├─ .gitignore
├─ apps
│  ├─ conf
│  │  ├─ base_conf.py
│  │  ├─ db_conf.py
│  │  ├─ kafka_conf.py
│  │  ├─ oss_conf.py
│  │  ├─ redis_conf.py
│  │  └─ __init__.py
│  ├─ handller
│  │  ├─ db_handller.py
│  │  ├─ kafka_handler.py
│  │  ├─ log_handller.py
│  │  ├─ word_handller.py
│  │  └─ __init__.py
│  ├─ models
│  │  ├─ entity_model
│  │  │  ├─ Incident.py
│  │  │  ├─ user.py
│  │  │  ├─ user_model.py
│  │  │  └─ __init__.py
│  │  ├─ lstm_model
│  │  │  ├─ config.py
│  │  │  ├─ data_utils.py
│  │  │  ├─ poetry.txt
│  │  │  ├─ poetry_model.py
│  │  │  └─ __init__.py
│  │  ├─ request_model
│  │  │  ├─ BaseModel.py
│  │  │  ├─ coordinate_model.py
│  │  │  ├─ user_request.py
│  │  │  └─ __init__.py
│  │  └─ __init__.py
│  ├─ routers
│  │  ├─ base_router
│  │  │  └─ base_router.py
│  │  ├─ detect
│  │  │  ├─ detect_api_helper.py
│  │  │  ├─ hard_scape_detection_api.py
│  │  │  └─ __init__.py
│  │  ├─ login
│  │  │  ├─ login_helper.py
│  │  │  └─ login_router.py
│  │  └─ router_manager.py
│  ├─ service
│  │  ├─ user_service.py
│  │  └─ __init__.py
│  └─ __init__.py
├─ Dockerfile
├─ gunicorn_conf.py
├─ main.py
└─ README.md

```

#### 3、 技术栈
    FastAPI
    Starlette
    Pydantic
    uvicorn
    SQLAlchemy
    Minio
    Redis
    bcrypt
    passlib
    jwt
### 安装教程

1. 在控制台执行pip install -r requirements.txt
2.  python main.py运行项目
3.  可以通过访问http:ip:8090/docs 或者http:ip:8090/redoc查看接口文档

#### 功能介绍

1.  该项目中配置了oss，db，redis等组件，实现了开箱即用的效果。
2.  基于fastapi.security实现了token获取及登录注册模块

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request