add api module Interfaces (#79)

* Add api module related interfaces

* Add filter to user paging query interface

Author: wu-clan

backend/app/api/v1/api.py

@@ -1,7 +1,55 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from fastapi import APIRouter
+from typing import Annotated
+
+from fastapi import APIRouter, Query
+
+from backend.app.common.casbin_rbac import DependsRBAC
+from backend.app.common.jwt import DependsUser, CurrentUser
+from backend.app.common.pagination import PageDepends, paging_data
+from backend.app.common.response.response_schema import response_base
+from backend.app.database.db_mysql import CurrentSession
+from backend.app.schemas.api import GetAllApi, CreateApi, UpdateApi
+from backend.app.services.api_service import ApiService
 
 router = APIRouter()
 
-# TODO: 添加 api 相关接口
+
+@router.get('/{pk}', summary='获取接口详情', dependencies=[DependsUser])
+async def get_api(pk: int):
+    api = await ApiService.get(pk=pk)
+    return response_base.success(data=api)
+
+
+@router.get('', summary='（模糊条件）分页获取所有接口', dependencies=[DependsUser, PageDepends])
+async def get_all_apis(
+    db: CurrentSession,
+    name: Annotated[str | None, Query()] = None,
+    method: Annotated[str | None, Query()] = None,
+    path: Annotated[str | None, Query()] = None,
+):
+    api_select = await ApiService.get_select(name=name, method=method, path=path)
+    page_data = await paging_data(db, api_select, GetAllApi)
+    return response_base.success(data=page_data)
+
+
+@router.post('', summary='创建接口', dependencies=[DependsRBAC])
+async def create_api(obj: CreateApi, user: CurrentUser):
+    await ApiService.create(obj=obj, user_id=user.id)
+    return response_base.success()
+
+
+@router.put('/{pk}', summary='更新接口', dependencies=[DependsRBAC])
+async def update_api(pk: int, obj: UpdateApi, user: CurrentUser):
+    count = await ApiService.update(pk=pk, obj=obj, user_id=user.id)
+    if count > 0:
+        return response_base.success()
+    return response_base.fail()
+
+
+@router.delete('', summary='（批量）删除接口', dependencies=[DependsRBAC])
+async def delete_api(pk: Annotated[list[int], Query(...)]):
+    count = await ApiService.delete(pk=pk)
+    if count > 0:
+        return response_base.success()
+    return response_base.fail()

backend/app/api/v1/user.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from fastapi import APIRouter
+from typing import Annotated
+
+from fastapi import APIRouter, Query
 
 from backend.app.common.jwt import DependsUser, CurrentUser, DependsSuperUser
 from backend.app.common.pagination import paging_data, PageDepends
@@ -28,7 +30,7 @@ async def password_reset(obj: ResetPassword):
 
 
 @router.get('/{username}', summary='查看用户信息', dependencies=[DependsUser])
-async def userinfo(username: str):
+async def get_user(username: str):
     current_user = await UserService.get_userinfo(username)
     data = GetAllUserInfo(**select_to_json(current_user))
     return response_base.success(data=data)
@@ -50,9 +52,14 @@ async def update_avatar(username: str, avatar: Avatar, current_user: CurrentUser
     return response_base.fail()
 
 
-@router.get('', summary='获取所有用户', dependencies=[DependsUser, PageDepends])
-async def get_all_users(db: CurrentSession):
-    user_select = await UserService.get_select()
+@router.get('', summary='（模糊条件）分页获取所有用户', dependencies=[DependsUser, PageDepends])
+async def get_all_users(
+        db: CurrentSession,
+        username: Annotated[str | None, Query()] = None,
+        phone: Annotated[str | None, Query()] = None,
+        status: Annotated[int | None, Query()] = None,
+):
+    user_select = await UserService.get_select(username=username, phone=phone, status=status)
     page_data = await paging_data(db, user_select, GetAllUserInfo)
     return response_base.success(data=page_data)
 

backend/app/crud/crud_api.py

@@ -1,13 +1,45 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from typing import NoReturn
+
+from sqlalchemy import Select, select, desc, delete, and_
+from sqlalchemy.ext.asyncio import AsyncSession
+
 from backend.app.crud.base import CRUDBase
 from backend.app.models import Api
 from backend.app.schemas.api import CreateApi, UpdateApi
 
 
 class CRUDApi(CRUDBase[Api, CreateApi, UpdateApi]):
-    # TODO: 添加 api 相关数据库操作
-    pass
+    async def get(self, db: AsyncSession, pk: int) -> Api | None:
+        return await self.get_(db, pk)
+
+    async def get_all(self, name: str = None, method: str = None, path: str = None) -> Select:
+        se = select(self.model).order_by(desc(self.model.created_time))
+        where_list = []
+        if name:
+            where_list.append(self.model.name.like(f'%{name}%'))
+        if method:
+            where_list.append(self.model.method == method)
+        if path:
+            where_list.append(self.model.path.like(f'%{path}%', escape='/'))
+        if where_list:
+            se = se.where(and_(*where_list))
+        return se
+
+    async def get_by_name(self, db: AsyncSession, name: str) -> Api | None:
+        api = await db.execute(select(self.model).where(self.model.name == name))
+        return api.scalars().first()
+
+    async def create(self, db: AsyncSession, obj_in: CreateApi, user_id: int) -> NoReturn:
+        await self.create_(db, obj_in, user_id)
+
+    async def update(self, db: AsyncSession, pk: int, obj_in: UpdateApi, user_id: int) -> int:
+        return await self.update_(db, pk, obj_in, user_id)
+
+    async def delete(self, db: AsyncSession, pk: list[int]) -> int:
+        apis = await db.execute(delete(self.model).where(self.model.id.in_(pk)))
+        return apis.rowcount
 
 
 ApiDao: CRUDApi = CRUDApi(Api)

backend/app/crud/crud_user.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from typing import NoReturn
 
-from sqlalchemy import select, update, desc
+from sqlalchemy import select, update, desc, and_
 from sqlalchemy.ext.asyncio import AsyncSession
 from sqlalchemy.orm import selectinload
 from sqlalchemy.sql import Select
@@ -66,12 +66,22 @@ async def reset_password(self, db: AsyncSession, pk: int, password: str) -> int:
         )
         return user.rowcount
 
-    def get_all(self) -> Select:
-        return (
+    async def get_all(self, username: str = None, phone: str = None, status: int = None) -> Select:
+        se = (
             select(self.model)
             .options(selectinload(self.model.roles).selectinload(Role.menus))
             .order_by(desc(self.model.time_joined))
         )
+        where_list = []
+        if username:
+            where_list.append(self.model.username.like(f'%{username}%'))
+        if phone:
+            where_list.append(self.model.phone.like(f'%{phone}%'))
+        if status is not None:
+            where_list.append(self.model.is_active == bool(status))
+        if where_list:
+            se = se.where(and_(*where_list))
+        return se
 
     async def get_super(self, db: AsyncSession, user_id: int) -> bool:
         user = await self.get(db, user_id)

backend/app/schemas/api.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-from curses.ascii import isupper
 from datetime import datetime
 
 from pydantic import BaseModel, Field, validator
@@ -10,13 +9,13 @@
 
 class ApiBase(BaseModel):
     name: str
-    method: str = Field(default=MethodType.GET, description='请求方法')
+    method: str = Field(..., description='请求方法')
     path: str = Field(..., description='api路径')
     remark: str | None = None
 
     @validator('method')
     def check_method(cls, v):
-        if not isupper(v):
+        if not v.isupper():
             raise ValueError('请求方式必须大写')
         allow_method = MethodType.get_member_values()
         if v not in allow_method:

backend/app/services/api_service.py

@@ -1,7 +1,43 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
+from sqlalchemy import Select
+
+from backend.app.common.exception import errors
+from backend.app.crud.crud_api import ApiDao
+from backend.app.database.db_mysql import async_db_session
+from backend.app.models import Api
+from backend.app.schemas.api import CreateApi, UpdateApi
 
 
 class ApiService:
-    # TODO: 添加 api 相关服务
-    pass
+    @staticmethod
+    async def get(*, pk: int) -> Api:
+        async with async_db_session.begin() as db:
+            api = await ApiDao.get(db, pk)
+            if not api:
+                raise errors.NotFoundError(msg='接口不存在')
+            return api
+
+    @staticmethod
+    async def get_select(*, name: str = None, method: str = None, path: str = None) -> Select:
+        return await ApiDao.get_all(name=name, method=method, path=path)
+
+    @staticmethod
+    async def create(*, obj: CreateApi, user_id: int) -> None:
+        async with async_db_session.begin() as db:
+            api = await ApiDao.get_by_name(db, obj.name)
+            if api:
+                raise errors.ForbiddenError(msg='接口已存在')
+            await ApiDao.create(db, obj, user_id)
+
+    @staticmethod
+    async def update(*, pk: int, obj: UpdateApi, user_id: int) -> int:
+        async with async_db_session.begin() as db:
+            count = await ApiDao.update(db, pk, obj, user_id)
+            return count
+
+    @staticmethod
+    async def delete(*, pk: list[int]) -> int:
+        async with async_db_session.begin() as db:
+            count = await ApiDao.delete(db, pk)
+            return count

backend/app/services/user_service.py

@@ -187,8 +187,8 @@ async def update_avatar(*, username: str, current_user: User, avatar: Avatar) ->
             return count
 
     @staticmethod
-    async def get_select() -> Select:
-        return UserDao.get_all()
+    async def get_select(*, username: str = None, phone: str = None, status: bool = None) -> Select:
+        return await UserDao.get_all(username=username, phone=phone, status=status)
 
     @staticmethod
     async def update_permission(pk: int) -> int: