Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heyfavour/vue-element-admin-fastapi
vue-element-admin-fastapi
https://github.com/heyfavour/vue-element-admin-fastapi
celery fastapi python-socketio socket-io vue vue-element-admin
Last synced: 8 days ago
JSON representation
vue-element-admin-fastapi
- Host: GitHub
- URL: https://github.com/heyfavour/vue-element-admin-fastapi
- Owner: heyfavour
- License: mit
- Created: 2020-07-21T06:19:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T02:41:50.000Z (over 1 year ago)
- Last Synced: 2024-02-14T21:36:57.981Z (9 months ago)
- Topics: celery, fastapi, python-socketio, socket-io, vue, vue-element-admin
- Language: Vue
- Homepage:
- Size: 946 KB
- Stars: 229
- Watchers: 11
- Forks: 58
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fastapi - :octocat: vue-element-admin-fastapi :star: 160+ :fork_and_knife: 30+ - `frontend:vue-element-admin`, `backend:fastapi` and Full Stack FastAPI and PostgreSQL. (Admin)
README
# vue-element-admin-fastapi
vue-element-admin-fastapi
frontend:vue-element-admin
backend:fastapi and Full Stack FastAPI and PostgreSQL
```
root:[vue-element-admin-fastapi]
|--frontend #vue-element-admin
|--backend
| |--app
| | |--alembic #alembic
| | |--app
| | | |--api
| | | | |--api_v1
| | | | | |--api.py
| | | | | |--endpoints
| | | | | |--report #excel export api 敏捷开发
| | | | | | |--gen_excel.py
| | | | | | |--gen_report.py
| | | | | | |--report
| | | | | | |--__init__.py
| | | | | |--system
| | | | | |--websocket #python-socketio,异步类视图区分命名空间
| | | | | | |--server.py
| | | | |--deps.py
| | | |--celery_app #celery
| | | | |--celery_app.py
| | | | |--worker
| | | | | |--example.py
| | | |--core
| | | | |--config.py
| | | | |--security.py
| | | |--crud
| | | |--db
| | | | |--base.py
| | | | |--session.py
| | | |--extensions
| | | | |--exception.py #全局异常捕获 暂时没有使用的需要,所以没用
| | | | |--logger.py #替代原来的日志
| | | | |--request_id.py #日志全链路追踪
| | | | |--utils.py #utils 主要使用了其中的list_to_tree
| | | |--initial_data.py #初始化数据
| | | |--main.py
| | | |--middleware #中间件
| | | | |--access_middle.py #中间件 登陆日志
| | | |--models #models Table
| | | |--schemas #schemas Pydantic
| | | |--tests
| | | |--__init__.py
| | |--pyproject.toml #项目所需要的包
| | |--scripts
|--logs #日志路径
| |--backend
| |--celery
```
#### socket.io
frontend:socket.io-client
backend:python-socketio
前后端版本兼容请去官网检查，我使用的已经是最新的版本
前端：socket.io-client version 3.X
后端：python-socketio version 5.X
#### celery
celery-redis
start celery:sh backend\app\worker-start.sh
#### middleware
#### EXCEL敏捷开发
axios发送get请求携带token,通过访问header['content-disposition']获取文件名(需要后端设置Access-Control-Expose-Headers)
frontend:frontend\vue-element-admin-fastapi\frontend\src\utils\ruoyi.js function download
backend:backend\app\app\api\api_v1\report\\_\_init\_\_.py
#### DEMO:服务器到期了,暂时不续
#### 开发规则整理：
1.模块化
2.router.include_router下对根路由的RESTFUL请求需要结尾加"/",这个需要前端配合，其他都不需要加"/"
#### 如何快速本地启动
##### python packages
```
cd vue-element-admin-fastapi\backend\app
pip install -r requirements.txt
```
##### ip及数据库连接
```
frontend
#websocket连接的ip
vue-element-admin-fastapi\frontend\src\views\monitor\server\index.vue
#开发环境连接的后端ip
vue-element-admin-fastapi\frontend\.env.development
#生产环境连接的后端ip
vue-element-admin-fastapi\frontend\.env.production
backend
#alembic的数据库连接
vue-element-admin-fastapi\backend\app\alembic\env.py
#后端的数据库连接
vue-element-admin-fastapi\backend\app\app\core\config.py
#celery的数据库连接
vue-element-admin-fastapi\backend\app\app\celery_app\celery_app.py
```
##### 数据准备
vue-element-admin-fastapi\backend\app\prestart.sh
```
#检查数据库连接
python /app/app/db_pre_start/backend_pre_start.py
#alembic初始化本地表结构
alembic revision --autogenerate -m "first commit"
alembic upgrade head
#初始化数据
python /app/app/initial_data.py
```
##### 开发环境启动
```
frontend:npm run dev
backend:python main.py
celery:见启动脚本
```
#### 联系方式:
QQ：619511821
#### 其他
##### 日志统计
私下用两台服务器搭了hadoop+hive+spark。log存到了hive中并用spark统计了访问频率，使用airflow进行任务调度
但是考虑到项目简洁纯粹,所以并没有提交。
把结果放到了生产，给大家看看结果，尤其是异常API访问，看看经常被扫描的API有哪些
#### TODO
计划今年升级到sqlalchemy1.4
#### 待框架解决问题
中间件日志记录参数问题
uvicorn ->app(revice,send) -> receive = queue.get()->api(revice)->send
以上是请求流程，如果在中间件中使用request.body() or reqeust.receive 就会导致queue中的参数被消耗掉,导致中间件的call_next block
有人采用重写reqeust.receive的办法，但是这种办法会导致streambody or 巨大的body无法获取的问题(框架通过more body = True 多次receive，重写后循环获取无法停止)。
fastapi作者尝试在apirouter中记录参数日志。但是个人觉得这种方法很不python，所以暂不采用。