4 |
5 |
2 |
3 |
4 |
5 |
228 |
229 | ## 打赏
230 | 如果项目有帮助到你，可以请作者喝杯咖啡~
231 |
232 | 
234 | 
235 | 
241 |
242 | ### Visitors Count
243 |
244 | 
245 |
--------------------------------------------------------------------------------
/app/__init__.py:
--------------------------------------------------------------------------------
1 | from contextlib import asynccontextmanager
2 |
3 | from fastapi import FastAPI
4 | from tortoise import Tortoise
5 |
6 | from app.core.exceptions import SettingNotFound
7 | from app.core.init_app import (
8 | init_data,
9 | make_middlewares,
10 | register_exceptions,
11 | register_routers,
12 | )
13 |
14 | try:
15 | from app.settings.config import settings
16 | except ImportError:
17 | raise SettingNotFound("Can not import settings")
18 |
19 |
20 | @asynccontextmanager
21 | async def lifespan(app: FastAPI):
22 | await init_data()
23 | yield
24 | await Tortoise.close_connections()
25 |
26 |
27 | def create_app() -> FastAPI:
28 | app = FastAPI(
29 | title=settings.APP_TITLE,
30 | description=settings.APP_DESCRIPTION,
31 | version=settings.VERSION,
32 | openapi_url="/openapi.json",
33 | middleware=make_middlewares(),
34 | lifespan=lifespan,
35 | )
36 | register_exceptions(app)
37 | register_routers(app, prefix="/api")
38 | return app
39 |
40 |
41 | app = create_app()
42 |
--------------------------------------------------------------------------------
/app/api/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .v1 import v1_router
4 |
5 | api_router = APIRouter()
6 | api_router.include_router(v1_router, prefix="/v1")
7 |
8 |
9 | __all__ = ["api_router"]
10 |
--------------------------------------------------------------------------------
/app/api/v1/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from app.core.dependency import DependPermission
4 |
5 | from .apis import apis_router
6 | from .auditlog import auditlog_router
7 | from .base import base_router
8 | from .depts import depts_router
9 | from .menus import menus_router
10 | from .roles import roles_router
11 | from .users import users_router
12 |
13 | v1_router = APIRouter()
14 |
15 | v1_router.include_router(base_router, prefix="/base")
16 | v1_router.include_router(users_router, prefix="/user", dependencies=[DependPermission])
17 | v1_router.include_router(roles_router, prefix="/role", dependencies=[DependPermission])
18 | v1_router.include_router(menus_router, prefix="/menu", dependencies=[DependPermission])
19 | v1_router.include_router(apis_router, prefix="/api", dependencies=[DependPermission])
20 | v1_router.include_router(depts_router, prefix="/dept", dependencies=[DependPermission])
21 | v1_router.include_router(auditlog_router, prefix="/auditlog", dependencies=[DependPermission])
22 |
--------------------------------------------------------------------------------
/app/api/v1/apis/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .apis import router
4 |
5 | apis_router = APIRouter()
6 | apis_router.include_router(router, tags=["API模块"])
7 |
8 | __all__ = ["apis_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/apis/apis.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter, Query
2 | from tortoise.expressions import Q
3 |
4 | from app.controllers.api import api_controller
5 | from app.schemas import Success, SuccessExtra
6 | from app.schemas.apis import *
7 |
8 | router = APIRouter()
9 |
10 |
11 | @router.get("/list", summary="查看API列表")
12 | async def list_api(
13 | page: int = Query(1, description="页码"),
14 | page_size: int = Query(10, description="每页数量"),
15 | path: str = Query(None, description="API路径"),
16 | summary: str = Query(None, description="API简介"),
17 | tags: str = Query(None, description="API模块"),
18 | ):
19 | q = Q()
20 | if path:
21 | q &= Q(path__contains=path)
22 | if summary:
23 | q &= Q(summary__contains=summary)
24 | if tags:
25 | q &= Q(tags__contains=tags)
26 | total, api_objs = await api_controller.list(page=page, page_size=page_size, search=q, order=["tags", "id"])
27 | data = [await obj.to_dict() for obj in api_objs]
28 | return SuccessExtra(data=data, total=total, page=page, page_size=page_size)
29 |
30 |
31 | @router.get("/get", summary="查看Api")
32 | async def get_api(
33 | id: int = Query(..., description="Api"),
34 | ):
35 | api_obj = await api_controller.get(id=id)
36 | data = await api_obj.to_dict()
37 | return Success(data=data)
38 |
39 |
40 | @router.post("/create", summary="创建Api")
41 | async def create_api(
42 | api_in: ApiCreate,
43 | ):
44 | await api_controller.create(obj_in=api_in)
45 | return Success(msg="Created Successfully")
46 |
47 |
48 | @router.post("/update", summary="更新Api")
49 | async def update_api(
50 | api_in: ApiUpdate,
51 | ):
52 | await api_controller.update(id=api_in.id, obj_in=api_in)
53 | return Success(msg="Update Successfully")
54 |
55 |
56 | @router.delete("/delete", summary="删除Api")
57 | async def delete_api(
58 | api_id: int = Query(..., description="ApiID"),
59 | ):
60 | await api_controller.remove(id=api_id)
61 | return Success(msg="Deleted Success")
62 |
63 |
64 | @router.post("/refresh", summary="刷新API列表")
65 | async def refresh_api():
66 | await api_controller.refresh_api()
67 | return Success(msg="OK")
68 |
--------------------------------------------------------------------------------
/app/api/v1/auditlog/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .auditlog import router
4 |
5 | auditlog_router = APIRouter()
6 | auditlog_router.include_router(router, tags=["审计日志模块"])
7 |
8 | __all__ = ["auditlog_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/auditlog/auditlog.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from fastapi import APIRouter, Query
3 | from tortoise.expressions import Q
4 |
5 | from app.models.admin import AuditLog
6 | from app.schemas import SuccessExtra
7 | from app.schemas.apis import *
8 |
9 | router = APIRouter()
10 |
11 |
12 | @router.get("/list", summary="查看操作日志")
13 | async def get_audit_log_list(
14 | page: int = Query(1, description="页码"),
15 | page_size: int = Query(10, description="每页数量"),
16 | username: str = Query("", description="操作人名称"),
17 | module: str = Query("", description="功能模块"),
18 | method: str = Query("", description="请求方法"),
19 | summary: str = Query("", description="接口描述"),
20 | status: int = Query(None, description="状态码"),
21 | start_time: datetime = Query("", description="开始时间"),
22 | end_time: datetime = Query("", description="结束时间"),
23 | ):
24 | q = Q()
25 | if username:
26 | q &= Q(username__icontains=username)
27 | if module:
28 | q &= Q(module__icontains=module)
29 | if method:
30 | q &= Q(method__icontains=method)
31 | if summary:
32 | q &= Q(summary__icontains=summary)
33 | if status:
34 | q &= Q(status=status)
35 | if start_time and end_time:
36 | q &= Q(created_at__range=[start_time, end_time])
37 | elif start_time:
38 | q &= Q(created_at__gte=start_time)
39 | elif end_time:
40 | q &= Q(created_at__lte=end_time)
41 |
42 | audit_log_objs = await AuditLog.filter(q).offset((page - 1) * page_size).limit(page_size).order_by("-created_at")
43 | total = await AuditLog.filter(q).count()
44 | data = [await audit_log.to_dict() for audit_log in audit_log_objs]
45 | return SuccessExtra(data=data, total=total, page=page, page_size=page_size)
46 |
--------------------------------------------------------------------------------
/app/api/v1/base/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .base import router
4 |
5 | base_router = APIRouter()
6 | base_router.include_router(router, tags=["基础模块"])
7 |
8 | __all__ = ["base_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/base/base.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime, timedelta, timezone
2 |
3 | from fastapi import APIRouter
4 |
5 | from app.controllers.user import user_controller
6 | from app.core.ctx import CTX_USER_ID
7 | from app.core.dependency import DependAuth
8 | from app.models.admin import Api, Menu, Role, User
9 | from app.schemas.base import Fail, Success
10 | from app.schemas.login import *
11 | from app.schemas.users import UpdatePassword
12 | from app.settings import settings
13 | from app.utils.jwt_utils import create_access_token
14 | from app.utils.password import get_password_hash, verify_password
15 |
16 | router = APIRouter()
17 |
18 |
19 | @router.post("/access_token", summary="获取token")
20 | async def login_access_token(credentials: CredentialsSchema):
21 | user: User = await user_controller.authenticate(credentials)
22 | await user_controller.update_last_login(user.id)
23 | access_token_expires = timedelta(minutes=settings.JWT_ACCESS_TOKEN_EXPIRE_MINUTES)
24 | expire = datetime.now(timezone.utc) + access_token_expires
25 |
26 | data = JWTOut(
27 | access_token=create_access_token(
28 | data=JWTPayload(
29 | user_id=user.id,
30 | username=user.username,
31 | is_superuser=user.is_superuser,
32 | exp=expire,
33 | )
34 | ),
35 | username=user.username,
36 | )
37 | return Success(data=data.model_dump())
38 |
39 |
40 | @router.get("/userinfo", summary="查看用户信息", dependencies=[DependAuth])
41 | async def get_userinfo():
42 | user_id = CTX_USER_ID.get()
43 | user_obj = await user_controller.get(id=user_id)
44 | data = await user_obj.to_dict(exclude_fields=["password"])
45 | data["avatar"] = "https://avatars.githubusercontent.com/u/54677442?v=4"
46 | return Success(data=data)
47 |
48 |
49 | @router.get("/usermenu", summary="查看用户菜单", dependencies=[DependAuth])
50 | async def get_user_menu():
51 | user_id = CTX_USER_ID.get()
52 | user_obj = await User.filter(id=user_id).first()
53 | menus: list[Menu] = []
54 | if user_obj.is_superuser:
55 | menus = await Menu.all()
56 | else:
57 | role_objs: list[Role] = await user_obj.roles
58 | for role_obj in role_objs:
59 | menu = await role_obj.menus
60 | menus.extend(menu)
61 | menus = list(set(menus))
62 | parent_menus: list[Menu] = []
63 | for menu in menus:
64 | if menu.parent_id == 0:
65 | parent_menus.append(menu)
66 | res = []
67 | for parent_menu in parent_menus:
68 | parent_menu_dict = await parent_menu.to_dict()
69 | parent_menu_dict["children"] = []
70 | for menu in menus:
71 | if menu.parent_id == parent_menu.id:
72 | parent_menu_dict["children"].append(await menu.to_dict())
73 | res.append(parent_menu_dict)
74 | return Success(data=res)
75 |
76 |
77 | @router.get("/userapi", summary="查看用户API", dependencies=[DependAuth])
78 | async def get_user_api():
79 | user_id = CTX_USER_ID.get()
80 | user_obj = await User.filter(id=user_id).first()
81 | if user_obj.is_superuser:
82 | api_objs: list[Api] = await Api.all()
83 | apis = [api.method.lower() + api.path for api in api_objs]
84 | return Success(data=apis)
85 | role_objs: list[Role] = await user_obj.roles
86 | apis = []
87 | for role_obj in role_objs:
88 | api_objs: list[Api] = await role_obj.apis
89 | apis.extend([api.method.lower() + api.path for api in api_objs])
90 | apis = list(set(apis))
91 | return Success(data=apis)
92 |
93 |
94 | @router.post("/update_password", summary="修改密码", dependencies=[DependAuth])
95 | async def update_user_password(req_in: UpdatePassword):
96 | user_id = CTX_USER_ID.get()
97 | user = await user_controller.get(user_id)
98 | verified = verify_password(req_in.old_password, user.password)
99 | if not verified:
100 | return Fail(msg="旧密码验证错误！")
101 | user.password = get_password_hash(req_in.new_password)
102 | await user.save()
103 | return Success(msg="修改成功")
104 |
--------------------------------------------------------------------------------
/app/api/v1/depts/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .depts import router
4 |
5 | depts_router = APIRouter()
6 | depts_router.include_router(router, tags=["部门模块"])
7 |
8 | __all__ = ["depts_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/depts/depts.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter, Query
2 |
3 | from app.controllers.dept import dept_controller
4 | from app.schemas import Success
5 | from app.schemas.depts import *
6 |
7 | router = APIRouter()
8 |
9 |
10 | @router.get("/list", summary="查看部门列表")
11 | async def list_dept(
12 | name: str = Query(None, description="部门名称"),
13 | ):
14 | dept_tree = await dept_controller.get_dept_tree(name)
15 | return Success(data=dept_tree)
16 |
17 |
18 | @router.get("/get", summary="查看部门")
19 | async def get_dept(
20 | id: int = Query(..., description="部门ID"),
21 | ):
22 | dept_obj = await dept_controller.get(id=id)
23 | data = await dept_obj.to_dict()
24 | return Success(data=data)
25 |
26 |
27 | @router.post("/create", summary="创建部门")
28 | async def create_dept(
29 | dept_in: DeptCreate,
30 | ):
31 | await dept_controller.create_dept(obj_in=dept_in)
32 | return Success(msg="Created Successfully")
33 |
34 |
35 | @router.post("/update", summary="更新部门")
36 | async def update_dept(
37 | dept_in: DeptUpdate,
38 | ):
39 | await dept_controller.update_dept(obj_in=dept_in)
40 | return Success(msg="Update Successfully")
41 |
42 |
43 | @router.delete("/delete", summary="删除部门")
44 | async def delete_dept(
45 | dept_id: int = Query(..., description="部门ID"),
46 | ):
47 | await dept_controller.delete_dept(dept_id=dept_id)
48 | return Success(msg="Deleted Success")
49 |
--------------------------------------------------------------------------------
/app/api/v1/menus/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .menus import router
4 |
5 | menus_router = APIRouter()
6 | menus_router.include_router(router, tags=["菜单模块"])
7 |
8 | __all__ = ["menus_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/menus/menus.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from fastapi import APIRouter, Query
4 |
5 | from app.controllers.menu import menu_controller
6 | from app.schemas.base import Fail, Success, SuccessExtra
7 | from app.schemas.menus import *
8 |
9 | logger = logging.getLogger(__name__)
10 |
11 | router = APIRouter()
12 |
13 |
14 | @router.get("/list", summary="查看菜单列表")
15 | async def list_menu(
16 | page: int = Query(1, description="页码"),
17 | page_size: int = Query(10, description="每页数量"),
18 | ):
19 | async def get_menu_with_children(menu_id: int):
20 | menu = await menu_controller.model.get(id=menu_id)
21 | menu_dict = await menu.to_dict()
22 | child_menus = await menu_controller.model.filter(parent_id=menu_id).order_by("order")
23 | menu_dict["children"] = [await get_menu_with_children(child.id) for child in child_menus]
24 | return menu_dict
25 |
26 | parent_menus = await menu_controller.model.filter(parent_id=0).order_by("order")
27 | res_menu = [await get_menu_with_children(menu.id) for menu in parent_menus]
28 | return SuccessExtra(data=res_menu, total=len(res_menu), page=page, page_size=page_size)
29 |
30 |
31 | @router.get("/get", summary="查看菜单")
32 | async def get_menu(
33 | menu_id: int = Query(..., description="菜单id"),
34 | ):
35 | result = await menu_controller.get(id=menu_id)
36 | return Success(data=result)
37 |
38 |
39 | @router.post("/create", summary="创建菜单")
40 | async def create_menu(
41 | menu_in: MenuCreate,
42 | ):
43 | await menu_controller.create(obj_in=menu_in)
44 | return Success(msg="Created Success")
45 |
46 |
47 | @router.post("/update", summary="更新菜单")
48 | async def update_menu(
49 | menu_in: MenuUpdate,
50 | ):
51 | await menu_controller.update(id=menu_in.id, obj_in=menu_in)
52 | return Success(msg="Updated Success")
53 |
54 |
55 | @router.delete("/delete", summary="删除菜单")
56 | async def delete_menu(
57 | id: int = Query(..., description="菜单id"),
58 | ):
59 | child_menu_count = await menu_controller.model.filter(parent_id=id).count()
60 | if child_menu_count > 0:
61 | return Fail(msg="Cannot delete a menu with child menus")
62 | await menu_controller.remove(id=id)
63 | return Success(msg="Deleted Success")
64 |
--------------------------------------------------------------------------------
/app/api/v1/roles/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .roles import router
4 |
5 | roles_router = APIRouter()
6 | roles_router.include_router(router, tags=["角色模块"])
7 |
8 | __all__ = ["roles_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/roles/roles.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from fastapi import APIRouter, Query
4 | from fastapi.exceptions import HTTPException
5 | from tortoise.expressions import Q
6 |
7 | from app.controllers import role_controller
8 | from app.schemas.base import Success, SuccessExtra
9 | from app.schemas.roles import *
10 |
11 | logger = logging.getLogger(__name__)
12 | router = APIRouter()
13 |
14 |
15 | @router.get("/list", summary="查看角色列表")
16 | async def list_role(
17 | page: int = Query(1, description="页码"),
18 | page_size: int = Query(10, description="每页数量"),
19 | role_name: str = Query("", description="角色名称，用于查询"),
20 | ):
21 | q = Q()
22 | if role_name:
23 | q = Q(name__contains=role_name)
24 | total, role_objs = await role_controller.list(page=page, page_size=page_size, search=q)
25 | data = [await obj.to_dict() for obj in role_objs]
26 | return SuccessExtra(data=data, total=total, page=page, page_size=page_size)
27 |
28 |
29 | @router.get("/get", summary="查看角色")
30 | async def get_role(
31 | role_id: int = Query(..., description="角色ID"),
32 | ):
33 | role_obj = await role_controller.get(id=role_id)
34 | return Success(data=await role_obj.to_dict())
35 |
36 |
37 | @router.post("/create", summary="创建角色")
38 | async def create_role(role_in: RoleCreate):
39 | if await role_controller.is_exist(name=role_in.name):
40 | raise HTTPException(
41 | status_code=400,
42 | detail="The role with this rolename already exists in the system.",
43 | )
44 | await role_controller.create(obj_in=role_in)
45 | return Success(msg="Created Successfully")
46 |
47 |
48 | @router.post("/update", summary="更新角色")
49 | async def update_role(role_in: RoleUpdate):
50 | await role_controller.update(id=role_in.id, obj_in=role_in)
51 | return Success(msg="Updated Successfully")
52 |
53 |
54 | @router.delete("/delete", summary="删除角色")
55 | async def delete_role(
56 | role_id: int = Query(..., description="角色ID"),
57 | ):
58 | await role_controller.remove(id=role_id)
59 | return Success(msg="Deleted Success")
60 |
61 |
62 | @router.get("/authorized", summary="查看角色权限")
63 | async def get_role_authorized(id: int = Query(..., description="角色ID")):
64 | role_obj = await role_controller.get(id=id)
65 | data = await role_obj.to_dict(m2m=True)
66 | return Success(data=data)
67 |
68 |
69 | @router.post("/authorized", summary="更新角色权限")
70 | async def update_role_authorized(role_in: RoleUpdateMenusApis):
71 | role_obj = await role_controller.get(id=role_in.id)
72 | await role_controller.update_roles(role=role_obj, menu_ids=role_in.menu_ids, api_infos=role_in.api_infos)
73 | return Success(msg="Updated Successfully")
74 |
--------------------------------------------------------------------------------
/app/api/v1/users/__init__.py:
--------------------------------------------------------------------------------
1 | from fastapi import APIRouter
2 |
3 | from .users import router
4 |
5 | users_router = APIRouter()
6 | users_router.include_router(router, tags=["用户模块"])
7 |
8 | __all__ = ["users_router"]
9 |
--------------------------------------------------------------------------------
/app/api/v1/users/users.py:
--------------------------------------------------------------------------------
1 | import logging
2 |
3 | from fastapi import APIRouter, Body, Query
4 | from tortoise.expressions import Q
5 |
6 | from app.controllers.dept import dept_controller
7 | from app.controllers.user import user_controller
8 | from app.schemas.base import Fail, Success, SuccessExtra
9 | from app.schemas.users import *
10 |
11 | logger = logging.getLogger(__name__)
12 |
13 | router = APIRouter()
14 |
15 |
16 | @router.get("/list", summary="查看用户列表")
17 | async def list_user(
18 | page: int = Query(1, description="页码"),
19 | page_size: int = Query(10, description="每页数量"),
20 | username: str = Query("", description="用户名称，用于搜索"),
21 | email: str = Query("", description="邮箱地址"),
22 | dept_id: int = Query(None, description="部门ID"),
23 | ):
24 | q = Q()
25 | if username:
26 | q &= Q(username__contains=username)
27 | if email:
28 | q &= Q(email__contains=email)
29 | if dept_id is not None:
30 | q &= Q(dept_id=dept_id)
31 | total, user_objs = await user_controller.list(page=page, page_size=page_size, search=q)
32 | data = [await obj.to_dict(m2m=True, exclude_fields=["password"]) for obj in user_objs]
33 | for item in data:
34 | dept_id = item.pop("dept_id", None)
35 | item["dept"] = await (await dept_controller.get(id=dept_id)).to_dict() if dept_id else {}
36 |
37 | return SuccessExtra(data=data, total=total, page=page, page_size=page_size)
38 |
39 |
40 | @router.get("/get", summary="查看用户")
41 | async def get_user(
42 | user_id: int = Query(..., description="用户ID"),
43 | ):
44 | user_obj = await user_controller.get(id=user_id)
45 | user_dict = await user_obj.to_dict(exclude_fields=["password"])
46 | return Success(data=user_dict)
47 |
48 |
49 | @router.post("/create", summary="创建用户")
50 | async def create_user(
51 | user_in: UserCreate,
52 | ):
53 | user = await user_controller.get_by_email(user_in.email)
54 | if user:
55 | return Fail(code=400, msg="The user with this email already exists in the system.")
56 | new_user = await user_controller.create_user(obj_in=user_in)
57 | await user_controller.update_roles(new_user, user_in.role_ids)
58 | return Success(msg="Created Successfully")
59 |
60 |
61 | @router.post("/update", summary="更新用户")
62 | async def update_user(
63 | user_in: UserUpdate,
64 | ):
65 | user = await user_controller.update(id=user_in.id, obj_in=user_in)
66 | await user_controller.update_roles(user, user_in.role_ids)
67 | return Success(msg="Updated Successfully")
68 |
69 |
70 | @router.delete("/delete", summary="删除用户")
71 | async def delete_user(
72 | user_id: int = Query(..., description="用户ID"),
73 | ):
74 | await user_controller.remove(id=user_id)
75 | return Success(msg="Deleted Successfully")
76 |
77 |
78 | @router.post("/reset_password", summary="重置密码")
79 | async def reset_password(user_id: int = Body(..., description="用户ID", embed=True)):
80 | await user_controller.reset_password(user_id)
81 | return Success(msg="密码已重置为123456")
82 |
--------------------------------------------------------------------------------
/app/controllers/__init__.py:
--------------------------------------------------------------------------------
1 | from .role import role_controller as role_controller
2 | from .user import user_controller as user_controller
3 |
--------------------------------------------------------------------------------
/app/controllers/api.py:
--------------------------------------------------------------------------------
1 | from fastapi.routing import APIRoute
2 |
3 | from app.core.crud import CRUDBase
4 | from app.log import logger
5 | from app.models.admin import Api
6 | from app.schemas.apis import ApiCreate, ApiUpdate
7 |
8 |
9 | class ApiController(CRUDBase[Api, ApiCreate, ApiUpdate]):
10 | def __init__(self):
11 | super().__init__(model=Api)
12 |
13 | async def refresh_api(self):
14 | from app import app
15 |
16 | # 删除废弃API数据
17 | all_api_list = []
18 | for route in app.routes:
19 | # 只更新有鉴权的API
20 | if isinstance(route, APIRoute) and len(route.dependencies) > 0:
21 | all_api_list.append((list(route.methods)[0], route.path_format))
22 | delete_api = []
23 | for api in await Api.all():
24 | if (api.method, api.path) not in all_api_list:
25 | delete_api.append((api.method, api.path))
26 | for item in delete_api:
27 | method, path = item
28 | logger.debug(f"API Deleted {method} {path}")
29 | await Api.filter(method=method, path=path).delete()
30 |
31 | for route in app.routes:
32 | if isinstance(route, APIRoute) and len(route.dependencies) > 0:
33 | method = list(route.methods)[0]
34 | path = route.path_format
35 | summary = route.summary
36 | tags = list(route.tags)[0]
37 | api_obj = await Api.filter(method=method, path=path).first()
38 | if api_obj:
39 | await api_obj.update_from_dict(dict(method=method, path=path, summary=summary, tags=tags)).save()
40 | else:
41 | logger.debug(f"API Created {method} {path}")
42 | await Api.create(**dict(method=method, path=path, summary=summary, tags=tags))
43 |
44 |
45 | api_controller = ApiController()
46 |
--------------------------------------------------------------------------------
/app/controllers/dept.py:
--------------------------------------------------------------------------------
1 | from tortoise.expressions import Q
2 | from tortoise.transactions import atomic
3 |
4 | from app.core.crud import CRUDBase
5 | from app.models.admin import Dept, DeptClosure
6 | from app.schemas.depts import DeptCreate, DeptUpdate
7 |
8 |
9 | class DeptController(CRUDBase[Dept, DeptCreate, DeptUpdate]):
10 | def __init__(self):
11 | super().__init__(model=Dept)
12 |
13 | async def get_dept_tree(self, name):
14 | q = Q()
15 | # 获取所有未被软删除的部门
16 | q &= Q(is_deleted=False)
17 | if name:
18 | q &= Q(name__contains=name)
19 | all_depts = await self.model.filter(q).order_by("order")
20 |
21 | # 辅助函数，用于递归构建部门树
22 | def build_tree(parent_id):
23 | return [
24 | {
25 | "id": dept.id,
26 | "name": dept.name,
27 | "desc": dept.desc,
28 | "order": dept.order,
29 | "parent_id": dept.parent_id,
30 | "children": build_tree(dept.id), # 递归构建子部门
31 | }
32 | for dept in all_depts
33 | if dept.parent_id == parent_id
34 | ]
35 |
36 | # 从顶级部门（parent_id=0）开始构建部门树
37 | dept_tree = build_tree(0)
38 | return dept_tree
39 |
40 | async def get_dept_info(self):
41 | pass
42 |
43 | async def update_dept_closure(self, obj: Dept):
44 | parent_depts = await DeptClosure.filter(descendant=obj.parent_id)
45 | for i in parent_depts:
46 | print(i.ancestor, i.descendant)
47 | dept_closure_objs: list[DeptClosure] = []
48 | # 插入父级关系
49 | for item in parent_depts:
50 | dept_closure_objs.append(DeptClosure(ancestor=item.ancestor, descendant=obj.id, level=item.level + 1))
51 | # 插入自身x
52 | dept_closure_objs.append(DeptClosure(ancestor=obj.id, descendant=obj.id, level=0))
53 | # 创建关系
54 | await DeptClosure.bulk_create(dept_closure_objs)
55 |
56 | @atomic()
57 | async def create_dept(self, obj_in: DeptCreate):
58 | # 创建
59 | if obj_in.parent_id != 0:
60 | await self.get(id=obj_in.parent_id)
61 | new_obj = await self.create(obj_in=obj_in)
62 | await self.update_dept_closure(new_obj)
63 |
64 | @atomic()
65 | async def update_dept(self, obj_in: DeptUpdate):
66 | dept_obj = await self.get(id=obj_in.id)
67 | # 更新部门关系
68 | if dept_obj.parent_id != obj_in.parent_id:
69 | await DeptClosure.filter(ancestor=dept_obj.id).delete()
70 | await DeptClosure.filter(descendant=dept_obj.id).delete()
71 | await self.update_dept_closure(dept_obj)
72 | # 更新部门信息
73 | dept_obj.update_from_dict(obj_in.model_dump(exclude_unset=True))
74 | await dept_obj.save()
75 |
76 | @atomic()
77 | async def delete_dept(self, dept_id: int):
78 | # 删除部门
79 | obj = await self.get(id=dept_id)
80 | obj.is_deleted = True
81 | await obj.save()
82 | # 删除关系
83 | await DeptClosure.filter(descendant=dept_id).delete()
84 |
85 |
86 | dept_controller = DeptController()
87 |
--------------------------------------------------------------------------------
/app/controllers/menu.py:
--------------------------------------------------------------------------------
1 | from typing import Optional
2 |
3 | from app.core.crud import CRUDBase
4 | from app.models.admin import Menu
5 | from app.schemas.menus import MenuCreate, MenuUpdate
6 |
7 |
8 | class MenuController(CRUDBase[Menu, MenuCreate, MenuUpdate]):
9 | def __init__(self):
10 | super().__init__(model=Menu)
11 |
12 | async def get_by_menu_path(self, path: str) -> Optional["Menu"]:
13 | return await self.model.filter(path=path).first()
14 |
15 |
16 | menu_controller = MenuController()
17 |
--------------------------------------------------------------------------------
/app/controllers/role.py:
--------------------------------------------------------------------------------
1 | from typing import List
2 |
3 | from app.core.crud import CRUDBase
4 | from app.models.admin import Api, Menu, Role
5 | from app.schemas.roles import RoleCreate, RoleUpdate
6 |
7 |
8 | class RoleController(CRUDBase[Role, RoleCreate, RoleUpdate]):
9 | def __init__(self):
10 | super().__init__(model=Role)
11 |
12 | async def is_exist(self, name: str) -> bool:
13 | return await self.model.filter(name=name).exists()
14 |
15 | async def update_roles(self, role: Role, menu_ids: List[int], api_infos: List[dict]) -> None:
16 | await role.menus.clear()
17 | for menu_id in menu_ids:
18 | menu_obj = await Menu.filter(id=menu_id).first()
19 | await role.menus.add(menu_obj)
20 |
21 | await role.apis.clear()
22 | for item in api_infos:
23 | api_obj = await Api.filter(path=item.get("path"), method=item.get("method")).first()
24 | await role.apis.add(api_obj)
25 |
26 |
27 | role_controller = RoleController()
28 |
--------------------------------------------------------------------------------
/app/controllers/user.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from typing import List, Optional
3 |
4 | from fastapi.exceptions import HTTPException
5 |
6 | from app.core.crud import CRUDBase
7 | from app.models.admin import User
8 | from app.schemas.login import CredentialsSchema
9 | from app.schemas.users import UserCreate, UserUpdate
10 | from app.utils.password import get_password_hash, verify_password
11 |
12 | from .role import role_controller
13 |
14 |
15 | class UserController(CRUDBase[User, UserCreate, UserUpdate]):
16 | def __init__(self):
17 | super().__init__(model=User)
18 |
19 | async def get_by_email(self, email: str) -> Optional[User]:
20 | return await self.model.filter(email=email).first()
21 |
22 | async def get_by_username(self, username: str) -> Optional[User]:
23 | return await self.model.filter(username=username).first()
24 |
25 | async def create_user(self, obj_in: UserCreate) -> User:
26 | obj_in.password = get_password_hash(password=obj_in.password)
27 | obj = await self.create(obj_in)
28 | return obj
29 |
30 | async def update_last_login(self, id: int) -> None:
31 | user = await self.model.get(id=id)
32 | user.last_login = datetime.now()
33 | await user.save()
34 |
35 | async def authenticate(self, credentials: CredentialsSchema) -> Optional["User"]:
36 | user = await self.model.filter(username=credentials.username).first()
37 | if not user:
38 | raise HTTPException(status_code=400, detail="无效的用户名")
39 | verified = verify_password(credentials.password, user.password)
40 | if not verified:
41 | raise HTTPException(status_code=400, detail="密码错误!")
42 | if not user.is_active:
43 | raise HTTPException(status_code=400, detail="用户已被禁用")
44 | return user
45 |
46 | async def update_roles(self, user: User, role_ids: List[int]) -> None:
47 | await user.roles.clear()
48 | for role_id in role_ids:
49 | role_obj = await role_controller.get(id=role_id)
50 | await user.roles.add(role_obj)
51 |
52 | async def reset_password(self, user_id: int):
53 | user_obj = await self.get(id=user_id)
54 | if user_obj.is_superuser:
55 | raise HTTPException(status_code=403, detail="不允许重置超级管理员密码")
56 | user_obj.password = get_password_hash(password="123456")
57 | await user_obj.save()
58 |
59 |
60 | user_controller = UserController()
61 |
--------------------------------------------------------------------------------
/app/core/bgtask.py:
--------------------------------------------------------------------------------
1 | from starlette.background import BackgroundTasks
2 |
3 | from .ctx import CTX_BG_TASKS
4 |
5 |
6 | class BgTasks:
7 | """后台任务统一管理"""
8 |
9 | @classmethod
10 | async def init_bg_tasks_obj(cls):
11 | """实例化后台任务，并设置到上下文"""
12 | bg_tasks = BackgroundTasks()
13 | CTX_BG_TASKS.set(bg_tasks)
14 |
15 | @classmethod
16 | async def get_bg_tasks_obj(cls):
17 | """从上下文中获取后台任务实例"""
18 | return CTX_BG_TASKS.get()
19 |
20 | @classmethod
21 | async def add_task(cls, func, *args, **kwargs):
22 | """添加后台任务"""
23 | bg_tasks = await cls.get_bg_tasks_obj()
24 | bg_tasks.add_task(func, *args, **kwargs)
25 |
26 | @classmethod
27 | async def execute_tasks(cls):
28 | """执行后台任务，一般是请求结果返回之后执行"""
29 | bg_tasks = await cls.get_bg_tasks_obj()
30 | if bg_tasks.tasks:
31 | await bg_tasks()
32 |
--------------------------------------------------------------------------------
/app/core/crud.py:
--------------------------------------------------------------------------------
1 | from typing import Any, Dict, Generic, List, NewType, Tuple, Type, TypeVar, Union
2 |
3 | from pydantic import BaseModel
4 | from tortoise.expressions import Q
5 | from tortoise.models import Model
6 |
7 | Total = NewType("Total", int)
8 | ModelType = TypeVar("ModelType", bound=Model)
9 | CreateSchemaType = TypeVar("CreateSchemaType", bound=BaseModel)
10 | UpdateSchemaType = TypeVar("UpdateSchemaType", bound=BaseModel)
11 |
12 |
13 | class CRUDBase(Generic[ModelType, CreateSchemaType, UpdateSchemaType]):
14 | def __init__(self, model: Type[ModelType]):
15 | self.model = model
16 |
17 | async def get(self, id: int) -> ModelType:
18 | return await self.model.get(id=id)
19 |
20 | async def list(self, page: int, page_size: int, search: Q = Q(), order: list = []) -> Tuple[Total, List[ModelType]]:
21 | query = self.model.filter(search)
22 | return await query.count(), await query.offset((page - 1) * page_size).limit(page_size).order_by(*order)
23 |
24 | async def create(self, obj_in: CreateSchemaType) -> ModelType:
25 | if isinstance(obj_in, Dict):
26 | obj_dict = obj_in
27 | else:
28 | obj_dict = obj_in.model_dump()
29 | obj = self.model(**obj_dict)
30 | await obj.save()
31 | return obj
32 |
33 | async def update(self, id: int, obj_in: Union[UpdateSchemaType, Dict[str, Any]]) -> ModelType:
34 | if isinstance(obj_in, Dict):
35 | obj_dict = obj_in
36 | else:
37 | obj_dict = obj_in.model_dump(exclude_unset=True, exclude={"id"})
38 | obj = await self.get(id=id)
39 | obj = obj.update_from_dict(obj_dict)
40 | await obj.save()
41 | return obj
42 |
43 | async def remove(self, id: int) -> None:
44 | obj = await self.get(id=id)
45 | await obj.delete()
46 |
--------------------------------------------------------------------------------
/app/core/ctx.py:
--------------------------------------------------------------------------------
1 | import contextvars
2 |
3 | from starlette.background import BackgroundTasks
4 |
5 | CTX_USER_ID: contextvars.ContextVar[int] = contextvars.ContextVar("user_id", default=0)
6 | CTX_BG_TASKS: contextvars.ContextVar[BackgroundTasks] = contextvars.ContextVar("bg_task", default=None)
7 |
--------------------------------------------------------------------------------
/app/core/dependency.py:
--------------------------------------------------------------------------------
1 | from typing import Optional
2 |
3 | import jwt
4 | from fastapi import Depends, Header, HTTPException, Request
5 |
6 | from app.core.ctx import CTX_USER_ID
7 | from app.models import Role, User
8 | from app.settings import settings
9 |
10 |
11 | class AuthControl:
12 | @classmethod
13 | async def is_authed(cls, token: str = Header(..., description="token验证")) -> Optional["User"]:
14 | try:
15 | if token == "dev":
16 | user = await User.filter().first()
17 | user_id = user.id
18 | else:
19 | decode_data = jwt.decode(token, settings.SECRET_KEY, algorithms=settings.JWT_ALGORITHM)
20 | user_id = decode_data.get("user_id")
21 | user = await User.filter(id=user_id).first()
22 | if not user:
23 | raise HTTPException(status_code=401, detail="Authentication failed")
24 | CTX_USER_ID.set(int(user_id))
25 | return user
26 | except jwt.DecodeError:
27 | raise HTTPException(status_code=401, detail="无效的Token")
28 | except jwt.ExpiredSignatureError:
29 | raise HTTPException(status_code=401, detail="登录已过期")
30 | except Exception as e:
31 | raise HTTPException(status_code=500, detail=f"{repr(e)}")
32 |
33 |
34 | class PermissionControl:
35 | @classmethod
36 | async def has_permission(cls, request: Request, current_user: User = Depends(AuthControl.is_authed)) -> None:
37 | if current_user.is_superuser:
38 | return
39 | method = request.method
40 | path = request.url.path
41 | roles: list[Role] = await current_user.roles
42 | if not roles:
43 | raise HTTPException(status_code=403, detail="The user is not bound to a role")
44 | apis = [await role.apis for role in roles]
45 | permission_apis = list(set((api.method, api.path) for api in sum(apis, [])))
46 | # path = "/api/v1/auth/userinfo"
47 | # method = "GET"
48 | if (method, path) not in permission_apis:
49 | raise HTTPException(status_code=403, detail=f"Permission denied method:{method} path:{path}")
50 |
51 |
52 | DependAuth = Depends(AuthControl.is_authed)
53 | DependPermission = Depends(PermissionControl.has_permission)
54 |
--------------------------------------------------------------------------------
/app/core/exceptions.py:
--------------------------------------------------------------------------------
1 | from fastapi.exceptions import (
2 | HTTPException,
3 | RequestValidationError,
4 | ResponseValidationError,
5 | )
6 | from fastapi.requests import Request
7 | from fastapi.responses import JSONResponse
8 | from tortoise.exceptions import DoesNotExist, IntegrityError
9 |
10 |
11 | class SettingNotFound(Exception):
12 | pass
13 |
14 |
15 | async def DoesNotExistHandle(req: Request, exc: DoesNotExist) -> JSONResponse:
16 | content = dict(
17 | code=404,
18 | msg=f"Object has not found, exc: {exc}, query_params: {req.query_params}",
19 | )
20 | return JSONResponse(content=content, status_code=404)
21 |
22 |
23 | async def IntegrityHandle(_: Request, exc: IntegrityError) -> JSONResponse:
24 | content = dict(
25 | code=500,
26 | msg=f"IntegrityError，{exc}",
27 | )
28 | return JSONResponse(content=content, status_code=500)
29 |
30 |
31 | async def HttpExcHandle(_: Request, exc: HTTPException) -> JSONResponse:
32 | content = dict(code=exc.status_code, msg=exc.detail, data=None)
33 | return JSONResponse(content=content, status_code=exc.status_code)
34 |
35 |
36 | async def RequestValidationHandle(_: Request, exc: RequestValidationError) -> JSONResponse:
37 | content = dict(code=422, msg=f"RequestValidationError, {exc}")
38 | return JSONResponse(content=content, status_code=422)
39 |
40 |
41 | async def ResponseValidationHandle(_: Request, exc: ResponseValidationError) -> JSONResponse:
42 | content = dict(code=500, msg=f"ResponseValidationError, {exc}")
43 | return JSONResponse(content=content, status_code=500)
44 |
--------------------------------------------------------------------------------
/app/log/__init__.py:
--------------------------------------------------------------------------------
1 | from .log import logger as logger
2 |
--------------------------------------------------------------------------------
/app/log/log.py:
--------------------------------------------------------------------------------
1 | import sys
2 |
3 | from loguru import logger as loguru_logger
4 |
5 | from app.settings import settings
6 |
7 |
8 | class Loggin:
9 | def __init__(self) -> None:
10 | debug = settings.DEBUG
11 | if debug:
12 | self.level = "DEBUG"
13 | else:
14 | self.level = "INFO"
15 |
16 | def setup_logger(self):
17 | loguru_logger.remove()
18 | loguru_logger.add(sink=sys.stdout, level=self.level)
19 |
20 | # logger.add("my_project.log", level=level, rotation="100 MB") # Output log messages to a file
21 | return loguru_logger
22 |
23 |
24 | loggin = Loggin()
25 | logger = loggin.setup_logger()
26 |
--------------------------------------------------------------------------------
/app/models/__init__.py:
--------------------------------------------------------------------------------
1 | # 新增model需要在这里导入
2 | from .admin import *
3 |
--------------------------------------------------------------------------------
/app/models/admin.py:
--------------------------------------------------------------------------------
1 | from tortoise import fields
2 |
3 | from app.schemas.menus import MenuType
4 |
5 | from .base import BaseModel, TimestampMixin
6 | from .enums import MethodType
7 |
8 |
9 | class User(BaseModel, TimestampMixin):
10 | username = fields.CharField(max_length=20, unique=True, description="用户名称", index=True)
11 | alias = fields.CharField(max_length=30, null=True, description="姓名", index=True)
12 | email = fields.CharField(max_length=255, unique=True, description="邮箱", index=True)
13 | phone = fields.CharField(max_length=20, null=True, description="电话", index=True)
14 | password = fields.CharField(max_length=128, null=True, description="密码")
15 | is_active = fields.BooleanField(default=True, description="是否激活", index=True)
16 | is_superuser = fields.BooleanField(default=False, description="是否为超级管理员", index=True)
17 | last_login = fields.DatetimeField(null=True, description="最后登录时间", index=True)
18 | roles = fields.ManyToManyField("models.Role", related_name="user_roles")
19 | dept_id = fields.IntField(null=True, description="部门ID", index=True)
20 |
21 | class Meta:
22 | table = "user"
23 |
24 |
25 | class Role(BaseModel, TimestampMixin):
26 | name = fields.CharField(max_length=20, unique=True, description="角色名称", index=True)
27 | desc = fields.CharField(max_length=500, null=True, description="角色描述")
28 | menus = fields.ManyToManyField("models.Menu", related_name="role_menus")
29 | apis = fields.ManyToManyField("models.Api", related_name="role_apis")
30 |
31 | class Meta:
32 | table = "role"
33 |
34 |
35 | class Api(BaseModel, TimestampMixin):
36 | path = fields.CharField(max_length=100, description="API路径", index=True)
37 | method = fields.CharEnumField(MethodType, description="请求方法", index=True)
38 | summary = fields.CharField(max_length=500, description="请求简介", index=True)
39 | tags = fields.CharField(max_length=100, description="API标签", index=True)
40 |
41 | class Meta:
42 | table = "api"
43 |
44 |
45 | class Menu(BaseModel, TimestampMixin):
46 | name = fields.CharField(max_length=20, description="菜单名称", index=True)
47 | remark = fields.JSONField(null=True, description="保留字段")
48 | menu_type = fields.CharEnumField(MenuType, null=True, description="菜单类型")
49 | icon = fields.CharField(max_length=100, null=True, description="菜单图标")
50 | path = fields.CharField(max_length=100, description="菜单路径", index=True)
51 | order = fields.IntField(default=0, description="排序", index=True)
52 | parent_id = fields.IntField(default=0, description="父菜单ID", index=True)
53 | is_hidden = fields.BooleanField(default=False, description="是否隐藏")
54 | component = fields.CharField(max_length=100, description="组件")
55 | keepalive = fields.BooleanField(default=True, description="存活")
56 | redirect = fields.CharField(max_length=100, null=True, description="重定向")
57 |
58 | class Meta:
59 | table = "menu"
60 |
61 |
62 | class Dept(BaseModel, TimestampMixin):
63 | name = fields.CharField(max_length=20, unique=True, description="部门名称", index=True)
64 | desc = fields.CharField(max_length=500, null=True, description="备注")
65 | is_deleted = fields.BooleanField(default=False, description="软删除标记", index=True)
66 | order = fields.IntField(default=0, description="排序", index=True)
67 | parent_id = fields.IntField(default=0, max_length=10, description="父部门ID", index=True)
68 |
69 | class Meta:
70 | table = "dept"
71 |
72 |
73 | class DeptClosure(BaseModel, TimestampMixin):
74 | ancestor = fields.IntField(description="父代", index=True)
75 | descendant = fields.IntField(description="子代", index=True)
76 | level = fields.IntField(default=0, description="深度", index=True)
77 |
78 |
79 | class AuditLog(BaseModel, TimestampMixin):
80 | user_id = fields.IntField(description="用户ID", index=True)
81 | username = fields.CharField(max_length=64, default="", description="用户名称", index=True)
82 | module = fields.CharField(max_length=64, default="", description="功能模块", index=True)
83 | summary = fields.CharField(max_length=128, default="", description="请求描述", index=True)
84 | method = fields.CharField(max_length=10, default="", description="请求方法", index=True)
85 | path = fields.CharField(max_length=255, default="", description="请求路径", index=True)
86 | status = fields.IntField(default=-1, description="状态码", index=True)
87 | response_time = fields.IntField(default=0, description="响应时间(单位ms)", index=True)
88 | request_args = fields.JSONField(null=True, description="请求参数")
89 | response_body = fields.JSONField(null=True, description="返回数据")
90 |
--------------------------------------------------------------------------------
/app/models/base.py:
--------------------------------------------------------------------------------
1 | import asyncio
2 | from datetime import datetime
3 |
4 | from tortoise import fields, models
5 |
6 | from app.settings import settings
7 |
8 |
9 | class BaseModel(models.Model):
10 | id = fields.BigIntField(pk=True, index=True)
11 |
12 | async def to_dict(self, m2m: bool = False, exclude_fields: list[str] | None = None):
13 | if exclude_fields is None:
14 | exclude_fields = []
15 |
16 | d = {}
17 | for field in self._meta.db_fields:
18 | if field not in exclude_fields:
19 | value = getattr(self, field)
20 | if isinstance(value, datetime):
21 | value = value.strftime(settings.DATETIME_FORMAT)
22 | d[field] = value
23 |
24 | if m2m:
25 | tasks = [
26 | self.__fetch_m2m_field(field, exclude_fields)
27 | for field in self._meta.m2m_fields
28 | if field not in exclude_fields
29 | ]
30 | results = await asyncio.gather(*tasks)
31 | for field, values in results:
32 | d[field] = values
33 |
34 | return d
35 |
36 | async def __fetch_m2m_field(self, field, exclude_fields):
37 | values = await getattr(self, field).all().values()
38 | formatted_values = []
39 |
40 | for value in values:
41 | formatted_value = {}
42 | for k, v in value.items():
43 | if k not in exclude_fields:
44 | if isinstance(v, datetime):
45 | formatted_value[k] = v.strftime(settings.DATETIME_FORMAT)
46 | else:
47 | formatted_value[k] = v
48 | formatted_values.append(formatted_value)
49 |
50 | return field, formatted_values
51 |
52 | class Meta:
53 | abstract = True
54 |
55 |
56 | class UUIDModel:
57 | uuid = fields.UUIDField(unique=True, pk=False, index=True)
58 |
59 |
60 | class TimestampMixin:
61 | created_at = fields.DatetimeField(auto_now_add=True, index=True)
62 | updated_at = fields.DatetimeField(auto_now=True, index=True)
63 |
--------------------------------------------------------------------------------
/app/models/enums.py:
--------------------------------------------------------------------------------
1 | from enum import Enum, StrEnum
2 |
3 |
4 | class EnumBase(Enum):
5 | @classmethod
6 | def get_member_values(cls):
7 | return [item.value for item in cls._member_map_.values()]
8 |
9 | @classmethod
10 | def get_member_names(cls):
11 | return [name for name in cls._member_names_]
12 |
13 |
14 | class MethodType(StrEnum):
15 | GET = "GET"
16 | POST = "POST"
17 | PUT = "PUT"
18 | DELETE = "DELETE"
19 | PATCH = "PATCH"
20 |
--------------------------------------------------------------------------------
/app/schemas/__init__.py:
--------------------------------------------------------------------------------
1 | from .base import *
2 |
--------------------------------------------------------------------------------
/app/schemas/apis.py:
--------------------------------------------------------------------------------
1 | from pydantic import BaseModel, Field
2 |
3 | from app.models.enums import MethodType
4 |
5 |
6 | class BaseApi(BaseModel):
7 | path: str = Field(..., description="API路径", example="/api/v1/user/list")
8 | summary: str = Field("", description="API简介", example="查看用户列表")
9 | method: MethodType = Field(..., description="API方法", example="GET")
10 | tags: str = Field(..., description="API标签", example="User")
11 |
12 |
13 | class ApiCreate(BaseApi): ...
14 |
15 |
16 | class ApiUpdate(BaseApi):
17 | id: int
18 |
--------------------------------------------------------------------------------
/app/schemas/base.py:
--------------------------------------------------------------------------------
1 | from typing import Any, Optional
2 |
3 | from fastapi.responses import JSONResponse
4 |
5 |
6 | class Success(JSONResponse):
7 | def __init__(
8 | self,
9 | code: int = 200,
10 | msg: Optional[str] = "OK",
11 | data: Optional[Any] = None,
12 | **kwargs,
13 | ):
14 | content = {"code": code, "msg": msg, "data": data}
15 | content.update(kwargs)
16 | super().__init__(content=content, status_code=code)
17 |
18 |
19 | class Fail(JSONResponse):
20 | def __init__(
21 | self,
22 | code: int = 400,
23 | msg: Optional[str] = None,
24 | data: Optional[Any] = None,
25 | **kwargs,
26 | ):
27 | content = {"code": code, "msg": msg, "data": data}
28 | content.update(kwargs)
29 | super().__init__(content=content, status_code=code)
30 |
31 |
32 | class SuccessExtra(JSONResponse):
33 | def __init__(
34 | self,
35 | code: int = 200,
36 | msg: Optional[str] = None,
37 | data: Optional[Any] = None,
38 | total: int = 0,
39 | page: int = 1,
40 | page_size: int = 20,
41 | **kwargs,
42 | ):
43 | content = {
44 | "code": code,
45 | "msg": msg,
46 | "data": data,
47 | "total": total,
48 | "page": page,
49 | "page_size": page_size,
50 | }
51 | content.update(kwargs)
52 | super().__init__(content=content, status_code=code)
53 |
--------------------------------------------------------------------------------
/app/schemas/depts.py:
--------------------------------------------------------------------------------
1 | from pydantic import BaseModel, Field
2 |
3 |
4 | class BaseDept(BaseModel):
5 | name: str = Field(..., description="部门名称", example="研发中心")
6 | desc: str = Field("", description="备注", example="研发中心")
7 | order: int = Field(0, description="排序")
8 | parent_id: int = Field(0, description="父部门ID")
9 |
10 |
11 | class DeptCreate(BaseDept): ...
12 |
13 |
14 | class DeptUpdate(BaseDept):
15 | id: int
16 |
17 | def update_dict(self):
18 | return self.model_dump(exclude_unset=True, exclude={"id"})
19 |
--------------------------------------------------------------------------------
/app/schemas/login.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 |
3 | from pydantic import BaseModel, Field
4 |
5 |
6 | class CredentialsSchema(BaseModel):
7 | username: str = Field(..., description="用户名称", example="admin")
8 | password: str = Field(..., description="密码", example="123456")
9 |
10 |
11 | class JWTOut(BaseModel):
12 | access_token: str
13 | username: str
14 |
15 |
16 | class JWTPayload(BaseModel):
17 | user_id: int
18 | username: str
19 | is_superuser: bool
20 | exp: datetime
21 |
--------------------------------------------------------------------------------
/app/schemas/menus.py:
--------------------------------------------------------------------------------
1 | from enum import StrEnum
2 | from typing import Optional
3 |
4 | from pydantic import BaseModel, Field
5 |
6 |
7 | class MenuType(StrEnum):
8 | CATALOG = "catalog" # 目录
9 | MENU = "menu" # 菜单
10 |
11 |
12 | class BaseMenu(BaseModel):
13 | id: int
14 | name: str
15 | path: str
16 | remark: Optional[dict]
17 | menu_type: Optional[MenuType]
18 | icon: Optional[str]
19 | order: int
20 | parent_id: int
21 | is_hidden: bool
22 | component: str
23 | keepalive: bool
24 | redirect: Optional[str]
25 | children: Optional[list["BaseMenu"]]
26 |
27 |
28 | class MenuCreate(BaseModel):
29 | menu_type: MenuType = Field(default=MenuType.CATALOG.value)
30 | name: str = Field(example="用户管理")
31 | icon: Optional[str] = "ph:user-list-bold"
32 | path: str = Field(example="/system/user")
33 | order: Optional[int] = Field(example=1)
34 | parent_id: Optional[int] = Field(example=0, default=0)
35 | is_hidden: Optional[bool] = False
36 | component: str = Field(default="Layout", example="/system/user")
37 | keepalive: Optional[bool] = True
38 | redirect: Optional[str] = ""
39 |
40 |
41 | class MenuUpdate(BaseModel):
42 | id: int
43 | menu_type: Optional[MenuType] = Field(example=MenuType.CATALOG.value)
44 | name: Optional[str] = Field(example="用户管理")
45 | icon: Optional[str] = "ph:user-list-bold"
46 | path: Optional[str] = Field(example="/system/user")
47 | order: Optional[int] = Field(example=1)
48 | parent_id: Optional[int] = Field(example=0)
49 | is_hidden: Optional[bool] = False
50 | component: str = Field(example="/system/user")
51 | keepalive: Optional[bool] = False
52 | redirect: Optional[str] = ""
53 |
--------------------------------------------------------------------------------
/app/schemas/roles.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from typing import Optional
3 |
4 | from pydantic import BaseModel, Field
5 |
6 |
7 | class BaseRole(BaseModel):
8 | id: int
9 | name: str
10 | desc: str = ""
11 | users: Optional[list] = []
12 | menus: Optional[list] = []
13 | apis: Optional[list] = []
14 | created_at: Optional[datetime]
15 | updated_at: Optional[datetime]
16 |
17 |
18 | class RoleCreate(BaseModel):
19 | name: str = Field(example="管理员")
20 | desc: str = Field("", example="管理员角色")
21 |
22 |
23 | class RoleUpdate(BaseModel):
24 | id: int = Field(example=1)
25 | name: str = Field(example="管理员")
26 | desc: str = Field("", example="管理员角色")
27 |
28 |
29 | class RoleUpdateMenusApis(BaseModel):
30 | id: int
31 | menu_ids: list[int] = []
32 | api_infos: list[dict] = []
33 |
--------------------------------------------------------------------------------
/app/schemas/users.py:
--------------------------------------------------------------------------------
1 | from datetime import datetime
2 | from typing import List, Optional
3 |
4 | from pydantic import BaseModel, EmailStr, Field
5 |
6 |
7 | class BaseUser(BaseModel):
8 | id: int
9 | email: Optional[EmailStr] = None
10 | username: Optional[str] = None
11 | is_active: Optional[bool] = True
12 | is_superuser: Optional[bool] = False
13 | created_at: Optional[datetime]
14 | updated_at: Optional[datetime]
15 | last_login: Optional[datetime]
16 | roles: Optional[list] = []
17 |
18 |
19 | class UserCreate(BaseModel):
20 | email: EmailStr = Field(example="admin@qq.com")
21 | username: str = Field(example="admin")
22 | password: str = Field(example="123456")
23 | is_active: Optional[bool] = True
24 | is_superuser: Optional[bool] = False
25 | role_ids: Optional[List[int]] = []
26 | dept_id: Optional[int] = Field(0, description="部门ID")
27 |
28 | def create_dict(self):
29 | return self.model_dump(exclude_unset=True, exclude={"role_ids"})
30 |
31 |
32 | class UserUpdate(BaseModel):
33 | id: int
34 | email: EmailStr
35 | username: str
36 | is_active: Optional[bool] = True
37 | is_superuser: Optional[bool] = False
38 | role_ids: Optional[List[int]] = []
39 | dept_id: Optional[int] = 0
40 |
41 |
42 | class UpdatePassword(BaseModel):
43 | old_password: str = Field(description="旧密码")
44 | new_password: str = Field(description="新密码")
45 |
--------------------------------------------------------------------------------
/app/settings/__init__.py:
--------------------------------------------------------------------------------
1 | from .config import settings as settings
2 |
3 | TORTOISE_ORM = settings.TORTOISE_ORM
4 |
--------------------------------------------------------------------------------
/app/settings/config.py:
--------------------------------------------------------------------------------
1 | import os
2 | import typing
3 |
4 | from pydantic_settings import BaseSettings
5 |
6 |
7 | class Settings(BaseSettings):
8 | VERSION: str = "0.1.0"
9 | APP_TITLE: str = "Vue FastAPI Admin"
10 | PROJECT_NAME: str = "Vue FastAPI Admin"
11 | APP_DESCRIPTION: str = "Description"
12 |
13 | CORS_ORIGINS: typing.List = ["*"]
14 | CORS_ALLOW_CREDENTIALS: bool = True
15 | CORS_ALLOW_METHODS: typing.List = ["*"]
16 | CORS_ALLOW_HEADERS: typing.List = ["*"]
17 |
18 | DEBUG: bool = True
19 |
20 | PROJECT_ROOT: str = os.path.abspath(os.path.join(os.path.dirname(__file__), os.pardir))
21 | BASE_DIR: str = os.path.abspath(os.path.join(PROJECT_ROOT, os.pardir))
22 | LOGS_ROOT: str = os.path.join(BASE_DIR, "app/logs")
23 | SECRET_KEY: str = "3488a63e1765035d386f05409663f55c83bfae3b3c61a932744b20ad14244dcf" # openssl rand -hex 32
24 | JWT_ALGORITHM: str = "HS256"
25 | JWT_ACCESS_TOKEN_EXPIRE_MINUTES: int = 60 * 24 * 7 # 7 day
26 | TORTOISE_ORM: dict = {
27 | "connections": {
28 | # SQLite configuration
29 | "sqlite": {
30 | "engine": "tortoise.backends.sqlite",
31 | "credentials": {"file_path": f"{BASE_DIR}/db.sqlite3"}, # Path to SQLite database file
32 | },
33 | # MySQL/MariaDB configuration
34 | # Install with: tortoise-orm[asyncmy]
35 | # "mysql": {
36 | # "engine": "tortoise.backends.mysql",
37 | # "credentials": {
38 | # "host": "localhost", # Database host address
39 | # "port": 3306, # Database port
40 | # "user": "yourusername", # Database username
41 | # "password": "yourpassword", # Database password
42 | # "database": "yourdatabase", # Database name
43 | # },
44 | # },
45 | # PostgreSQL configuration
46 | # Install with: tortoise-orm[asyncpg]
47 | # "postgres": {
48 | # "engine": "tortoise.backends.asyncpg",
49 | # "credentials": {
50 | # "host": "localhost", # Database host address
51 | # "port": 5432, # Database port
52 | # "user": "yourusername", # Database username
53 | # "password": "yourpassword", # Database password
54 | # "database": "yourdatabase", # Database name
55 | # },
56 | # },
57 | # MSSQL/Oracle configuration
58 | # Install with: tortoise-orm[asyncodbc]
59 | # "oracle": {
60 | # "engine": "tortoise.backends.asyncodbc",
61 | # "credentials": {
62 | # "host": "localhost", # Database host address
63 | # "port": 1433, # Database port
64 | # "user": "yourusername", # Database username
65 | # "password": "yourpassword", # Database password
66 | # "database": "yourdatabase", # Database name
67 | # },
68 | # },
69 | # SQLServer configuration
70 | # Install with: tortoise-orm[asyncodbc]
71 | # "sqlserver": {
72 | # "engine": "tortoise.backends.asyncodbc",
73 | # "credentials": {
74 | # "host": "localhost", # Database host address
75 | # "port": 1433, # Database port
76 | # "user": "yourusername", # Database username
77 | # "password": "yourpassword", # Database password
78 | # "database": "yourdatabase", # Database name
79 | # },
80 | # },
81 | },
82 | "apps": {
83 | "models": {
84 | "models": ["app.models", "aerich.models"],
85 | "default_connection": "sqlite",
86 | },
87 | },
88 | "use_tz": False, # Whether to use timezone-aware datetimes
89 | "timezone": "Asia/Shanghai", # Timezone setting
90 | }
91 | DATETIME_FORMAT: str = "%Y-%m-%d %H:%M:%S"
92 |
93 |
94 | settings = Settings()
95 |
--------------------------------------------------------------------------------
/app/utils/jwt_utils.py:
--------------------------------------------------------------------------------
1 | import jwt
2 |
3 | from app.schemas.login import JWTPayload
4 | from app.settings.config import settings
5 |
6 |
7 | def create_access_token(*, data: JWTPayload):
8 | payload = data.model_dump().copy()
9 | encoded_jwt = jwt.encode(payload, settings.SECRET_KEY, algorithm=settings.JWT_ALGORITHM)
10 | return encoded_jwt
11 |
--------------------------------------------------------------------------------
/app/utils/password.py:
--------------------------------------------------------------------------------
1 | from passlib import pwd
2 | from passlib.context import CryptContext
3 |
4 | pwd_context = CryptContext(schemes=["argon2"], deprecated="auto")
5 |
6 |
7 | def verify_password(plain_password: str, hashed_password: str) -> bool:
8 | return pwd_context.verify(plain_password, hashed_password)
9 |
10 |
11 | def get_password_hash(password: str) -> str:
12 | return pwd_context.hash(password)
13 |
14 |
15 | def generate_password() -> str:
16 | return pwd.genword()
17 |
--------------------------------------------------------------------------------
/deploy/entrypoint.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | set -e
3 |
4 | nginx
5 | python run.py
--------------------------------------------------------------------------------
/deploy/sample-picture/1.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/1.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/2.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/2.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/3.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/3.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/api.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/api.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/group.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/group.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/login.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/login.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/menu.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/menu.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/role.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/role.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/user.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/user.jpg
--------------------------------------------------------------------------------
/deploy/sample-picture/workbench.jpg:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/mizhexiaoxiao/vue-fastapi-admin/d32a1df922b6bcb02b0347bfe0712668dedbc7cd/deploy/sample-picture/workbench.jpg
--------------------------------------------------------------------------------
/deploy/web.conf:
--------------------------------------------------------------------------------
1 | server {
2 | listen 80;
3 | server_name localhost;
4 | location / {
5 | root /opt/vue-fastapi-admin/web/dist;
6 | index index.html index.htm;
7 | try_files $uri /index.html;
8 | }
9 | location ^~ /api/ {
10 | proxy_pass http://127.0.0.1:9999;
11 | }
12 |
13 | }
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [project]
2 | name = "vue-fastapi-admin"
3 | version = "0.1.0"
4 | description = "Vue Fastapi admin"
5 | authors = [
6 | {name = "mizhexiaoxiao", email = "mizhexiaoxiao@gmail.com"},
7 | ]
8 | requires-python = ">=3.11"
9 | dependencies = [
10 | "fastapi==0.111.0",
11 | "tortoise-orm==0.23.0",
12 | "pydantic==2.10.5",
13 | "email-validator==2.2.0",
14 | "passlib==1.7.4",
15 | "pyjwt==2.10.1",
16 | "black==24.10.0",
17 | "isort==5.13.2",
18 | "ruff==0.9.1",
19 | "loguru==0.7.3",
20 | "pydantic-settings==2.7.1",
21 | "argon2-cffi==23.1.0",
22 | "pydantic-core==2.27.2",
23 | "annotated-types==0.7.0",
24 | "setuptools==75.8.0",
25 | "uvicorn==0.34.0",
26 | "h11==0.14.0",
27 | "aerich==0.8.1",
28 | "aiosqlite==0.20.0",
29 | "anyio==4.8.0",
30 | "argon2-cffi-bindings==21.2.0",
31 | "asyncclick==8.1.8",
32 | "certifi==2024.12.14",
33 | "cffi==1.17.1",
34 | "click==8.1.8",
35 | "dictdiffer==0.9.0",
36 | "dnspython==2.7.0",
37 | "fastapi-cli==0.0.7",
38 | "httpcore==1.0.7",
39 | "httptools==0.6.4",
40 | "httpx==0.28.1",
41 | "idna==3.10",
42 | "iso8601==2.1.0",
43 | "jinja2==3.1.5",
44 | "markdown-it-py==3.0.0",
45 | "markupsafe==3.0.2",
46 | "mdurl==0.1.2",
47 | "mypy-extensions==1.0.0",
48 | "orjson==3.10.14",
49 | "packaging==24.2",
50 | "pathspec==0.12.1",
51 | "platformdirs==4.3.6",
52 | "pycparser==2.22",
53 | "pygments==2.19.1",
54 | "pypika-tortoise==0.3.2",
55 | "python-dotenv==1.0.1",
56 | "python-multipart==0.0.20",
57 | "pytz==2024.2",
58 | "pyyaml==6.0.2",
59 | "rich==13.9.4",
60 | "rich-toolkit==0.13.2",
61 | "shellingham==1.5.4",
62 | "sniffio==1.3.1",
63 | "starlette==0.37.2",
64 | "typer==0.15.1",
65 | "typing-extensions==4.12.2",
66 | "ujson==5.10.0",
67 | "uvloop==0.21.0",
68 | "watchfiles==1.0.4",
69 | "websockets==14.1",
70 | "pyproject-toml>=0.1.0",
71 | "uvloop==0.21.0 ; sys_platform != 'win32'",
72 | ]
73 |
74 | [tool.black]
75 | line-length = 120
76 | target-version = ["py310", "py311"]
77 |
78 | [tool.ruff]
79 | line-length = 120
80 | lint.extend-select = []
81 | lint.ignore = [
82 | "F403",
83 | "F405",
84 | ]
85 |
86 | [tool.aerich]
87 | tortoise_orm = "app.settings.TORTOISE_ORM"
88 | location = "./migrations"
89 | src_folder = "./."
90 |
--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
1 | aerich==0.8.1
2 | aiosqlite==0.20.0
3 | annotated-types==0.7.0
4 | anyio==4.8.0
5 | argon2-cffi==23.1.0
6 | argon2-cffi-bindings==21.2.0
7 | asyncclick==8.1.8
8 | black==24.10.0
9 | certifi==2024.12.14
10 | cffi==1.17.1
11 | click==8.1.8
12 | dictdiffer==0.9.0
13 | dnspython==2.7.0
14 | email-validator==2.2.0
15 | fastapi==0.111.0
16 | fastapi-cli==0.0.7
17 | h11==0.14.0
18 | httpcore==1.0.7
19 | httptools==0.6.4
20 | httpx==0.28.1
21 | idna==3.10
22 | iso8601==2.1.0
23 | isort==5.13.2
24 | jinja2==3.1.5
25 | loguru==0.7.3
26 | markdown-it-py==3.0.0
27 | markupsafe==3.0.2
28 | mdurl==0.1.2
29 | mypy-extensions==1.0.0
30 | orjson==3.10.14
31 | packaging==24.2
32 | passlib==1.7.4
33 | pathspec==0.12.1
34 | platformdirs==4.3.6
35 | pycparser==2.22
36 | pydantic==2.10.5
37 | pydantic-core==2.27.2
38 | pydantic-settings==2.7.1
39 | pygments==2.19.1
40 | pyjwt==2.10.1
41 | pypika-tortoise==0.3.2
42 | python-dotenv==1.0.1
43 | python-multipart==0.0.20
44 | pytz==2024.2
45 | pyyaml==6.0.2
46 | rich==13.9.4
47 | rich-toolkit==0.13.2
48 | ruff==0.9.1
49 | setuptools==75.8.0
50 | shellingham==1.5.4
51 | sniffio==1.3.1
52 | starlette==0.37.2
53 | tortoise-orm==0.23.0
54 | typer==0.15.1
55 | typing-extensions==4.12.2
56 | ujson==5.10.0
57 | uvicorn==0.34.0
58 | uvloop==0.21.0; sys_platform != 'win32'
59 | watchfiles==1.0.4
60 | websockets==14.1
61 |
--------------------------------------------------------------------------------
/run.py:
--------------------------------------------------------------------------------
1 | import uvicorn
2 | from uvicorn.config import LOGGING_CONFIG
3 |
4 | if __name__ == "__main__":
5 | # 修改默认日志配置
6 | LOGGING_CONFIG["formatters"]["default"]["fmt"] = "%(asctime)s - %(levelname)s - %(message)s"
7 | LOGGING_CONFIG["formatters"]["default"]["datefmt"] = "%Y-%m-%d %H:%M:%S"
8 | LOGGING_CONFIG["formatters"]["access"][
9 | "fmt"
10 | ] = '%(asctime)s - %(levelname)s - %(client_addr)s - "%(request_line)s" %(status_code)s'
11 | LOGGING_CONFIG["formatters"]["access"]["datefmt"] = "%Y-%m-%d %H:%M:%S"
12 |
13 | uvicorn.run("app:app", host="0.0.0.0", port=9999, reload=True, log_config=LOGGING_CONFIG)
14 |
--------------------------------------------------------------------------------
/web/.env:
--------------------------------------------------------------------------------
1 | VITE_TITLE = 'Vue FastAPI Admin'
2 |
3 | VITE_PORT = 3100
--------------------------------------------------------------------------------
/web/.env.development:
--------------------------------------------------------------------------------
1 | # 资源公共路径,需要以 /开头和结尾
2 | VITE_PUBLIC_PATH = '/'
3 |
4 | # 是否启用代理
5 | VITE_USE_PROXY = true
6 |
7 | # base api
8 | VITE_BASE_API = '/api/v1'
9 |
--------------------------------------------------------------------------------
/web/.env.production:
--------------------------------------------------------------------------------
1 | # 资源公共路径,需要以 /开头和结尾
2 | VITE_PUBLIC_PATH = '/'
3 |
4 | # base api
5 | VITE_BASE_API = '/api/v1'
6 |
7 | # 是否启用压缩
8 | VITE_USE_COMPRESS = true
9 |
10 | # 压缩类型
11 | VITE_COMPRESS_TYPE = gzip
--------------------------------------------------------------------------------
/web/.eslint-global-variables.json:
--------------------------------------------------------------------------------
1 | {
2 | "globals": {
3 | "$loadingBar": true,
4 | "$message": true,
5 | "defineOptions": true,
6 | "$dialog": true,
7 | "$notification": true,
8 | "EffectScope": true,
9 | "computed": true,
10 | "createApp": true,
11 | "customRef": true,
12 | "defineAsyncComponent": true,
13 | "defineComponent": true,
14 | "effectScope": true,
15 | "getCurrentInstance": true,
16 | "getCurrentScope": true,
17 | "h": true,
18 | "inject": true,
19 | "isProxy": true,
20 | "isReactive": true,
21 | "isReadonly": true,
22 | "isRef": true,
23 | "markRaw": true,
24 | "nextTick": true,
25 | "onActivated": true,
26 | "onBeforeMount": true,
27 | "onBeforeUnmount": true,
28 | "onBeforeUpdate": true,
29 | "onDeactivated": true,
30 | "onErrorCaptured": true,
31 | "onMounted": true,
32 | "onRenderTracked": true,
33 | "onRenderTriggered": true,
34 | "onScopeDispose": true,
35 | "onServerPrefetch": true,
36 | "onUnmounted": true,
37 | "onUpdated": true,
38 | "provide": true,
39 | "reactive": true,
40 | "readonly": true,
41 | "ref": true,
42 | "resolveComponent": true,
43 | "shallowReactive": true,
44 | "shallowReadonly": true,
45 | "shallowRef": true,
46 | "toRaw": true,
47 | "toRef": true,
48 | "toRefs": true,
49 | "triggerRef": true,
50 | "unref": true,
51 | "useAttrs": true,
52 | "useCssModule": true,
53 | "useCssVars": true,
54 | "useRoute": true,
55 | "useRouter": true,
56 | "useSlots": true,
57 | "watch": true,
58 | "watchEffect": true,
59 | "watchPostEffect": true,
60 | "watchSyncEffect": true
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/web/.eslintignore:
--------------------------------------------------------------------------------
1 | node_modules
2 | dist
3 | public
4 | package.json
--------------------------------------------------------------------------------
/web/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 | pnpm-debug.log*
8 | lerna-debug.log*
9 |
10 | node_modules
11 | .DS_Store
12 | dist
13 | dist-ssr
14 | coverage
15 | *.local
16 | stats.html
17 |
18 | # Editor directories and files
19 | .vscode/*
20 | !.vscode/extensions.json
21 | .idea
22 | *.suo
23 | *.ntvs*
24 | *.njsproj
25 | *.sln
26 | *.sw?
27 |
--------------------------------------------------------------------------------
/web/.prettierignore:
--------------------------------------------------------------------------------
1 | /node_modules/**
2 | /dist/*
3 | /public/*
--------------------------------------------------------------------------------
/web/.prettierrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "printWidth": 100,
3 | "singleQuote": true,
4 | "semi": false,
5 | "endOfLine": "lf"
6 | }
7 |
--------------------------------------------------------------------------------
/web/README.md:
--------------------------------------------------------------------------------
1 | ## 快速开始
2 |
3 | 进入前端目录
4 |
5 | ```sh
6 | cd web
7 | ```
8 |
9 | 安装依赖(建议使用pnpm: https://pnpm.io/zh/installation)
10 |
11 | ```sh
12 | npm i -g pnpm # 已安装可忽略
13 | pnpm i # 或者 npm i
14 | ```
15 |
16 | 启动
17 |
18 | ```sh
19 | pnpm dev
20 | ```
21 |
--------------------------------------------------------------------------------
/web/build/config/define.js:
--------------------------------------------------------------------------------
1 | import dayjs from 'dayjs'
2 |
3 | /**
4 | * * 此处定义的是全局常量，启动或打包后将添加到window中
5 | * https://vitejs.cn/config/#define
6 | */
7 |
8 | // 项目构建时间
9 | const _BUILD_TIME_ = JSON.stringify(dayjs().format('YYYY-MM-DD HH:mm:ss'))
10 |
11 | export const viteDefine = {
12 | _BUILD_TIME_,
13 | }
14 |
--------------------------------------------------------------------------------
/web/build/config/index.js:
--------------------------------------------------------------------------------
1 | export * from './define'
2 |
--------------------------------------------------------------------------------
/web/build/constant.js:
--------------------------------------------------------------------------------
1 | export const OUTPUT_DIR = 'dist'
2 |
3 | export const PROXY_CONFIG = {
4 | // /**
5 | // * @desc 替换匹配值
6 | // * @请求路径 http://localhost:3100/api/user
7 | // * @转发路径 http://localhost:9999/api/v1 +/user
8 | // */
9 | // '/api': {
10 | // target: 'http://localhost:9999/api/v1',
11 | // changeOrigin: true,
12 | // rewrite: (path) => path.replace(new RegExp('^/api'), ''),
13 | // },
14 | /**
15 | * @desc 不替换匹配值
16 | * @请求路径 http://localhost:3100/api/v1/user
17 | * @转发路径 http://localhost:9999/api/v1/user
18 | */
19 | '/api/v1': {
20 | target: 'http://127.0.0.1:9999',
21 | changeOrigin: true,
22 | },
23 | }
24 |
--------------------------------------------------------------------------------
/web/build/plugin/html.js:
--------------------------------------------------------------------------------
1 | import { createHtmlPlugin } from 'vite-plugin-html'
2 |
3 | export function configHtmlPlugin(viteEnv, isBuild) {
4 | const { VITE_TITLE } = viteEnv
5 |
6 | const htmlPlugin = createHtmlPlugin({
7 | minify: isBuild,
8 | inject: {
9 | data: {
10 | title: VITE_TITLE,
11 | },
12 | },
13 | })
14 | return htmlPlugin
15 | }
16 |
--------------------------------------------------------------------------------
/web/build/plugin/index.js:
--------------------------------------------------------------------------------
1 | import vue from '@vitejs/plugin-vue'
2 |
3 | /**
4 | * * unocss插件，原子css
5 | * https://github.com/antfu/unocss
6 | */
7 | import Unocss from 'unocss/vite'
8 |
9 | // rollup打包分析插件
10 | import visualizer from 'rollup-plugin-visualizer'
11 | // 压缩
12 | import viteCompression from 'vite-plugin-compression'
13 |
14 | import { configHtmlPlugin } from './html'
15 | import unplugin from './unplugin'
16 |
17 | export function createVitePlugins(viteEnv, isBuild) {
18 | const plugins = [vue(), ...unplugin, configHtmlPlugin(viteEnv, isBuild), Unocss()]
19 |
20 | if (viteEnv.VITE_USE_COMPRESS) {
21 | plugins.push(viteCompression({ algorithm: viteEnv.VITE_COMPRESS_TYPE || 'gzip' }))
22 | }
23 |
24 | if (isBuild) {
25 | plugins.push(
26 | visualizer({
27 | open: true,
28 | gzipSize: true,
29 | brotliSize: true,
30 | }),
31 | )
32 | }
33 |
34 | return plugins
35 | }
36 |
--------------------------------------------------------------------------------
/web/build/plugin/unplugin.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path'
2 | import AutoImport from 'unplugin-auto-import/vite'
3 | import Components from 'unplugin-vue-components/vite'
4 | import { NaiveUiResolver } from 'unplugin-vue-components/resolvers'
5 | import { FileSystemIconLoader } from 'unplugin-icons/loaders'
6 | import IconsResolver from 'unplugin-icons/resolver'
7 |
8 | /**
9 | * * unplugin-icons插件，自动引入iconify图标
10 | * usage: https://github.com/antfu/unplugin-icons
11 | * 图标库: https://icones.js.org/
12 | */
13 | import Icons from 'unplugin-icons/vite'
14 | import { createSvgIconsPlugin } from 'vite-plugin-svg-icons'
15 |
16 | import { getSrcPath } from '../utils'
17 |
18 | const customIconPath = resolve(getSrcPath(), 'assets/svg')
19 |
20 | export default [
21 | AutoImport({
22 | imports: ['vue', 'vue-router'],
23 | dts: false,
24 | }),
25 | Icons({
26 | compiler: 'vue3',
27 | customCollections: {
28 | custom: FileSystemIconLoader(customIconPath),
29 | },
30 | scale: 1,
31 | defaultClass: 'inline-block',
32 | }),
33 | Components({
34 | resolvers: [
35 | NaiveUiResolver(),
36 | IconsResolver({ customCollections: ['custom'], componentPrefix: 'icon' }),
37 | ],
38 | dts: false,
39 | }),
40 | createSvgIconsPlugin({
41 | iconDirs: [customIconPath],
42 | symbolId: 'icon-custom-[dir]-[name]',
43 | inject: 'body-last',
44 | customDomId: '__CUSTOM_SVG_ICON__',
45 | }),
46 | ]
47 |
--------------------------------------------------------------------------------
/web/build/script/build-cname.js:
--------------------------------------------------------------------------------
1 | import { resolve } from 'path'
2 | import chalk from 'chalk'
3 | import { writeFileSync } from 'fs-extra'
4 | import { OUTPUT_DIR } from '../constant'
5 | import { getEnvConfig, getRootPath } from '../utils'
6 |
7 | export function runBuildCNAME() {
8 | const { VITE_CNAME } = getEnvConfig()
9 | if (!VITE_CNAME) return
10 | try {
11 | writeFileSync(resolve(getRootPath(), `${OUTPUT_DIR}/CNAME`), VITE_CNAME)
12 | } catch (error) {
13 | console.log(chalk.red('CNAME file failed to package:\n' + error))
14 | }
15 | }
16 |
--------------------------------------------------------------------------------
/web/build/script/index.js:
--------------------------------------------------------------------------------
1 | import chalk from 'chalk'
2 | import { runBuildCNAME } from './build-cname'
3 |
4 | export const runBuild = async () => {
5 | try {
6 | runBuildCNAME()
7 | console.log(`✨ ${chalk.cyan('build successfully!')}`)
8 | } catch (error) {
9 | console.log(chalk.red('vite build error:\n' + error))
10 | process.exit(1)
11 | }
12 | }
13 |
14 | runBuild()
15 |
--------------------------------------------------------------------------------
/web/build/utils.js:
--------------------------------------------------------------------------------
1 | import fs from 'fs'
2 | import path from 'path'
3 | import dotenv from 'dotenv'
4 |
5 | /**
6 | * * 项目根路径
7 | * @descrition 结尾不带/
8 | */
9 | export function getRootPath() {
10 | return path.resolve(process.cwd())
11 | }
12 |
13 | /**
14 | * * 项目src路径
15 | * @param srcName src目录名称(默认: "src")
16 | * @descrition 结尾不带斜杠
17 | */
18 | export function getSrcPath(srcName = 'src') {
19 | return path.resolve(getRootPath(), srcName)
20 | }
21 |
22 | export function convertEnv(envOptions) {
23 | const result = {}
24 | if (!envOptions) return result
25 |
26 | for (const envKey in envOptions) {
27 | let envVal = envOptions[envKey]
28 | if (['true', 'false'].includes(envVal)) envVal = envVal === 'true'
29 |
30 | if (['VITE_PORT'].includes(envKey)) envVal = +envVal
31 |
32 | result[envKey] = envVal
33 | }
34 | return result
35 | }
36 |
37 | /**
38 | * 获取当前环境下生效的配置文件名
39 | */
40 | function getConfFiles() {
41 | const script = process.env.npm_lifecycle_script
42 | const reg = new RegExp('--mode ([a-z_\\d]+)')
43 | const result = reg.exec(script)
44 | if (result) {
45 | const mode = result[1]
46 | return ['.env', '.env.local', `.env.${mode}`]
47 | }
48 | return ['.env', '.env.local', '.env.production']
49 | }
50 |
51 | export function getEnvConfig(match = 'VITE_', confFiles = getConfFiles()) {
52 | let envConfig = {}
53 | confFiles.forEach((item) => {
54 | try {
55 | if (fs.existsSync(path.resolve(process.cwd(), item))) {
56 | const env = dotenv.parse(fs.readFileSync(path.resolve(process.cwd(), item)))
57 | envConfig = { ...envConfig, ...env }
58 | }
59 | } catch (e) {
60 | console.error(`Error in parsing ${item}`, e)
61 | }
62 | })
63 | const reg = new RegExp(`^(${match})`)
64 | Object.keys(envConfig).forEach((key) => {
65 | if (!reg.test(key)) {
66 | Reflect.deleteProperty(envConfig, key)
67 | }
68 | })
69 | return envConfig
70 | }
71 |
--------------------------------------------------------------------------------
/web/i18n/index.js:
--------------------------------------------------------------------------------
1 | import { createI18n } from 'vue-i18n'
2 | import { lStorage } from '@/utils'
3 |
4 | import messages from './messages'
5 |
6 | const currentLocale = lStorage.get('locale')
7 |
8 | const i18n = createI18n({
9 | legacy: false,
10 | globalInjection: true,
11 | locale: currentLocale || 'cn',
12 | fallbackLocale: 'cn',
13 | messages: messages,
14 | })
15 |
16 | export default i18n
17 |
--------------------------------------------------------------------------------
/web/i18n/messages/cn.json:
--------------------------------------------------------------------------------
1 | {
2 | "lang": "中文",
3 | "app_name": "Vue FastAPI Admin",
4 | "header": {
5 | "label_profile": "个人信息",
6 | "label_logout": "退出登录",
7 | "label_logout_dialog_title": "提示",
8 | "text_logout_confirm": "确认退出？",
9 | "text_logout_success": "已退出登录"
10 | },
11 | "views": {
12 | "login": {
13 | "text_login": "登录",
14 | "message_input_username_password": "请输入用户名和密码",
15 | "message_verifying": "正在验证...",
16 | "message_login_success": "登录成功"
17 | },
18 | "workbench": {
19 | "label_workbench": "工作台",
20 | "text_hello": "hello, {username}",
21 | "text_welcome": "今天又是元气满满的一天!",
22 | "label_number_of_items": "项目数",
23 | "label_upcoming": "待办",
24 | "label_information": "消息",
25 | "label_project": "项目",
26 | "label_more": "更多"
27 | },
28 | "profile": {
29 | "label_profile": "个人中心",
30 | "label_modify_information": "修改信息",
31 | "label_change_password": "修改密码",
32 | "label_avatar": "头像",
33 | "label_username": "用户姓名",
34 | "label_email": "邮箱",
35 | "label_old_password": "旧密码",
36 | "label_new_password": "新密码",
37 | "label_confirm_password": "确认密码",
38 | "placeholder_username": "请填写姓名",
39 | "placeholder_email": "请填写邮箱",
40 | "placeholder_old_password": "请输入旧密码",
41 | "placeholder_new_password": "请输入新密码",
42 | "placeholder_confirm_password": "请再次输入新密码",
43 | "message_username_required": "请输入昵称",
44 | "message_old_password_required": "请输入旧密码",
45 | "message_new_password_required": "请输入新密码",
46 | "message_password_confirmation_required": "请再次输入密码",
47 | "message_password_confirmation_diff": "两次密码输入不一致"
48 | },
49 | "errors": {
50 | "label_error": "错误页",
51 | "text_back_to_home": "返回首页"
52 | }
53 | },
54 | "common": {
55 | "text": {
56 | "update_success": "修改成功"
57 | },
58 | "buttons": {
59 | "update": "修改"
60 | }
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/web/i18n/messages/en.json:
--------------------------------------------------------------------------------
1 | {
2 | "lang": "English",
3 | "app_name": "Vue FastAPI Admin",
4 | "header": {
5 | "label_profile": "Profile",
6 | "label_logout": "Logout",
7 | "label_logout_dialog_title": "Hint",
8 | "text_logout_confirm": "Logout confirm",
9 | "text_logout_success": "Logout success"
10 | },
11 | "views": {
12 | "login": {
13 | "text_login": "Login",
14 | "message_input_username_password": "Please enter username and password",
15 | "message_verifying": "Verifying...",
16 | "message_login_success": "Login successful"
17 | },
18 | "workbench": {
19 | "label_workbench": "Workbench",
20 | "text_hello": "hello, {username}",
21 | "text_welcome": "Today is another day full of energy!",
22 | "label_number_of_items": "Number of items",
23 | "label_upcoming": "Upcoming",
24 | "label_information": "Information",
25 | "label_project": "Project",
26 | "label_more": "More"
27 | },
28 | "profile": {
29 | "label_profile": "Profile",
30 | "label_modify_information": "Modify your information",
31 | "label_change_password": "Change password",
32 | "label_avatar": "Avatar",
33 | "label_username": "Username",
34 | "label_email": "Email",
35 | "label_old_password": "Old password",
36 | "label_new_password": "New password",
37 | "label_confirm_password": "Password confirmation",
38 | "placeholder_username": "Please fill in your name",
39 | "placeholder_email": "Please fill in your email address",
40 | "placeholder_old_password": "Please enter the old password",
41 | "placeholder_new_password": "Please enter a new password",
42 | "placeholder_confirm_password": "Please enter the confirm password",
43 | "message_username_required": "Please enter username",
44 | "message_old_password_required": "Please enter the old password",
45 | "message_new_password_required": "Please enter a new password",
46 | "message_password_confirmation_required": "Please enter confirm password",
47 | "message_password_confirmation_diff": "Two password inputs are inconsistent"
48 | },
49 | "errors": {
50 | "label_error": "Error",
51 | "text_back_to_home": "Back to home"
52 | }
53 | },
54 | "common": {
55 | "text": {
56 | "update_success": "Update success"
57 | },
58 | "buttons": {
59 | "update": "Update"
60 | }
61 | }
62 | }
63 |
--------------------------------------------------------------------------------
/web/i18n/messages/index.js:
--------------------------------------------------------------------------------
1 | import * as en from './en.json'
2 | import * as cn from './cn.json'
3 |
4 | export default {
5 | en,
6 | cn,
7 | }
8 |
--------------------------------------------------------------------------------
/web/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 | {{ emptyDesc }}
12 |{{ networkErrorDesc }}
22 |10 | {{ $t('views.workbench.text_hello', { username: userStore.name }) }} 11 |
12 |{{ $t('views.workbench.text_welcome') }}
13 |{{ dummyText }}
41 |