perf: 优化API文档的响应模型显示

This commit is contained in:
insistence
2025-12-12 17:44:54 +08:00
parent 1656670203
commit 1f51b628af
10 changed files with 108 additions and 43 deletions
@@ -10,12 +10,12 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel, DeleteConfigModel from module_admin.entity.vo.config_vo import ConfigModel, ConfigPageQueryModel, DeleteConfigModel
from module_admin.entity.vo.user_vo import CurrentUserModel from module_admin.entity.vo.user_vo import CurrentUserModel
from module_admin.service.config_service import ConfigService from module_admin.service.config_service import ConfigService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
config_controller = APIRouter(prefix='/system/config', dependencies=[PreAuthDependency()]) config_controller = APIRouter(prefix='/system/config', dependencies=[PreAuthDependency()])
@@ -23,7 +23,7 @@ config_controller = APIRouter(prefix='/system/config', dependencies=[PreAuthDepe
@config_controller.get( @config_controller.get(
'/list', '/list',
response_model=PageResponseModel, response_model=PageResponseModel[ConfigModel],
dependencies=[UserInterfaceAuthDependency('system:config:list')], dependencies=[UserInterfaceAuthDependency('system:config:list')],
) )
async def get_system_config_list( async def get_system_config_list(
@@ -40,6 +40,7 @@ async def get_system_config_list(
@config_controller.post( @config_controller.post(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:config:add')], dependencies=[UserInterfaceAuthDependency('system:config:add')],
) )
@ValidateFields(validate_model='add_config') @ValidateFields(validate_model='add_config')
@@ -62,6 +63,7 @@ async def add_system_config(
@config_controller.put( @config_controller.put(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:config:edit')], dependencies=[UserInterfaceAuthDependency('system:config:edit')],
) )
@ValidateFields(validate_model='edit_config') @ValidateFields(validate_model='edit_config')
@@ -82,6 +84,7 @@ async def edit_system_config(
@config_controller.delete( @config_controller.delete(
'/refreshCache', '/refreshCache',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:config:remove')], dependencies=[UserInterfaceAuthDependency('system:config:remove')],
) )
@Log(title='参数管理', business_type=BusinessType.UPDATE) @Log(title='参数管理', business_type=BusinessType.UPDATE)
@@ -97,6 +100,7 @@ async def refresh_system_config(
@config_controller.delete( @config_controller.delete(
'/{config_ids}', '/{config_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:config:remove')], dependencies=[UserInterfaceAuthDependency('system:config:remove')],
) )
@Log(title='参数管理', business_type=BusinessType.DELETE) @Log(title='参数管理', business_type=BusinessType.DELETE)
@@ -114,7 +118,7 @@ async def delete_system_config(
@config_controller.get( @config_controller.get(
'/{config_id}', '/{config_id}',
response_model=ConfigModel, response_model=DataResponseModel[ConfigModel],
dependencies=[UserInterfaceAuthDependency('system:config:query')], dependencies=[UserInterfaceAuthDependency('system:config:query')],
) )
async def query_detail_system_config( async def query_detail_system_config(
@@ -128,7 +132,10 @@ async def query_detail_system_config(
return ResponseUtil.success(data=config_detail_result) return ResponseUtil.success(data=config_detail_result)
@config_controller.get('/configKey/{config_key}') @config_controller.get(
'/configKey/{config_key}',
response_model=ResponseBaseModel,
)
async def query_system_config(request: Request, config_key: str) -> Response: async def query_system_config(request: Request, config_key: str) -> Response:
# 获取全量数据 # 获取全量数据
config_query_result = await ConfigService.query_config_list_from_cache_services(request.app.state.redis, config_key) config_query_result = await ConfigService.query_config_list_from_cache_services(request.app.state.redis, config_key)
@@ -10,6 +10,7 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.dict_vo import ( from module_admin.entity.vo.dict_vo import (
DeleteDictDataModel, DeleteDictDataModel,
DeleteDictTypeModel, DeleteDictTypeModel,
@@ -22,7 +23,6 @@ from module_admin.entity.vo.user_vo import CurrentUserModel
from module_admin.service.dict_service import DictDataService, DictTypeService from module_admin.service.dict_service import DictDataService, DictTypeService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
dict_controller = APIRouter(prefix='/system/dict', dependencies=[PreAuthDependency()]) dict_controller = APIRouter(prefix='/system/dict', dependencies=[PreAuthDependency()])
@@ -30,7 +30,7 @@ dict_controller = APIRouter(prefix='/system/dict', dependencies=[PreAuthDependen
@dict_controller.get( @dict_controller.get(
'/type/list', '/type/list',
response_model=PageResponseModel, response_model=PageResponseModel[DictTypeModel],
dependencies=[UserInterfaceAuthDependency('system:dict:list')], dependencies=[UserInterfaceAuthDependency('system:dict:list')],
) )
async def get_system_dict_type_list( async def get_system_dict_type_list(
@@ -49,6 +49,7 @@ async def get_system_dict_type_list(
@dict_controller.post( @dict_controller.post(
'/type', '/type',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:add')], dependencies=[UserInterfaceAuthDependency('system:dict:add')],
) )
@ValidateFields(validate_model='add_dict_type') @ValidateFields(validate_model='add_dict_type')
@@ -71,6 +72,7 @@ async def add_system_dict_type(
@dict_controller.put( @dict_controller.put(
'/type', '/type',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:edit')], dependencies=[UserInterfaceAuthDependency('system:dict:edit')],
) )
@ValidateFields(validate_model='edit_dict_type') @ValidateFields(validate_model='edit_dict_type')
@@ -91,6 +93,7 @@ async def edit_system_dict_type(
@dict_controller.delete( @dict_controller.delete(
'/type/refreshCache', '/type/refreshCache',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:remove')], dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
) )
@Log(title='字典类型', business_type=BusinessType.UPDATE) @Log(title='字典类型', business_type=BusinessType.UPDATE)
@@ -103,6 +106,7 @@ async def refresh_system_dict(request: Request, query_db: Annotated[AsyncSession
@dict_controller.delete( @dict_controller.delete(
'/type/{dict_ids}', '/type/{dict_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:remove')], dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
) )
@Log(title='字典类型', business_type=BusinessType.DELETE) @Log(title='字典类型', business_type=BusinessType.DELETE)
@@ -118,7 +122,10 @@ async def delete_system_dict_type(
return ResponseUtil.success(msg=delete_dict_type_result.message) return ResponseUtil.success(msg=delete_dict_type_result.message)
@dict_controller.get('/type/optionselect', response_model=list[DictTypeModel]) @dict_controller.get(
'/type/optionselect',
response_model=DataResponseModel[list[DictTypeModel]],
)
async def query_system_dict_type_options( async def query_system_dict_type_options(
request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()] request: Request, query_db: Annotated[AsyncSession, DBSessionDependency()]
) -> Response: ) -> Response:
@@ -132,7 +139,7 @@ async def query_system_dict_type_options(
@dict_controller.get( @dict_controller.get(
'/type/{dict_id}', '/type/{dict_id}',
response_model=DictTypeModel, response_model=DataResponseModel[DictTypeModel],
dependencies=[UserInterfaceAuthDependency('system:dict:query')], dependencies=[UserInterfaceAuthDependency('system:dict:query')],
) )
async def query_detail_system_dict_type( async def query_detail_system_dict_type(
@@ -166,7 +173,10 @@ async def export_system_dict_type_list(
return ResponseUtil.streaming(data=bytes2file_response(dict_type_export_result)) return ResponseUtil.streaming(data=bytes2file_response(dict_type_export_result))
@dict_controller.get('/data/type/{dict_type}') @dict_controller.get(
'/data/type/{dict_type}',
response_model=DataResponseModel[list[DictDataModel]],
)
async def query_system_dict_type_data( async def query_system_dict_type_data(
request: Request, request: Request,
dict_type: Annotated[str, Path(description='字典类型')], dict_type: Annotated[str, Path(description='字典类型')],
@@ -183,7 +193,7 @@ async def query_system_dict_type_data(
@dict_controller.get( @dict_controller.get(
'/data/list', '/data/list',
response_model=PageResponseModel, response_model=PageResponseModel[DictDataModel],
dependencies=[UserInterfaceAuthDependency('system:dict:list')], dependencies=[UserInterfaceAuthDependency('system:dict:list')],
) )
async def get_system_dict_data_list( async def get_system_dict_data_list(
@@ -202,6 +212,7 @@ async def get_system_dict_data_list(
@dict_controller.post( @dict_controller.post(
'/data', '/data',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:add')], dependencies=[UserInterfaceAuthDependency('system:dict:add')],
) )
@ValidateFields(validate_model='add_dict_data') @ValidateFields(validate_model='add_dict_data')
@@ -224,6 +235,7 @@ async def add_system_dict_data(
@dict_controller.put( @dict_controller.put(
'/data', '/data',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:edit')], dependencies=[UserInterfaceAuthDependency('system:dict:edit')],
) )
@ValidateFields(validate_model='edit_dict_data') @ValidateFields(validate_model='edit_dict_data')
@@ -244,6 +256,7 @@ async def edit_system_dict_data(
@dict_controller.delete( @dict_controller.delete(
'/data/{dict_codes}', '/data/{dict_codes}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:dict:remove')], dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
) )
@Log(title='字典数据', business_type=BusinessType.DELETE) @Log(title='字典数据', business_type=BusinessType.DELETE)
@@ -261,7 +274,7 @@ async def delete_system_dict_data(
@dict_controller.get( @dict_controller.get(
'/data/{dict_code}', '/data/{dict_code}',
response_model=DictDataModel, response_model=DataResponseModel[DictDataModel],
dependencies=[UserInterfaceAuthDependency('system:dict:query')], dependencies=[UserInterfaceAuthDependency('system:dict:query')],
) )
async def query_detail_system_dict_data( async def query_detail_system_dict_data(
@@ -10,10 +10,12 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.job_vo import ( from module_admin.entity.vo.job_vo import (
DeleteJobLogModel, DeleteJobLogModel,
DeleteJobModel, DeleteJobModel,
EditJobModel, EditJobModel,
JobLogModel,
JobLogPageQueryModel, JobLogPageQueryModel,
JobModel, JobModel,
JobPageQueryModel, JobPageQueryModel,
@@ -23,7 +25,6 @@ from module_admin.service.job_log_service import JobLogService
from module_admin.service.job_service import JobService from module_admin.service.job_service import JobService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
job_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]) job_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()])
@@ -31,7 +32,7 @@ job_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]
@job_controller.get( @job_controller.get(
'/job/list', '/job/list',
response_model=PageResponseModel, response_model=PageResponseModel[JobModel],
dependencies=[UserInterfaceAuthDependency('monitor:job:list')], dependencies=[UserInterfaceAuthDependency('monitor:job:list')],
) )
async def get_system_job_list( async def get_system_job_list(
@@ -40,14 +41,15 @@ async def get_system_job_list(
query_db: Annotated[AsyncSession, DBSessionDependency()], query_db: Annotated[AsyncSession, DBSessionDependency()],
) -> Response: ) -> Response:
# 获取分页数据 # 获取分页数据
notice_page_query_result = await JobService.get_job_list_services(query_db, job_page_query, is_page=True) job_page_query_result = await JobService.get_job_list_services(query_db, job_page_query, is_page=True)
logger.info('获取成功') logger.info('获取成功')
return ResponseUtil.success(model_content=notice_page_query_result) return ResponseUtil.success(model_content=job_page_query_result)
@job_controller.post( @job_controller.post(
'/job', '/job',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:add')], dependencies=[UserInterfaceAuthDependency('monitor:job:add')],
) )
@ValidateFields(validate_model='add_job') @ValidateFields(validate_model='add_job')
@@ -70,6 +72,7 @@ async def add_system_job(
@job_controller.put( @job_controller.put(
'/job', '/job',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:edit')], dependencies=[UserInterfaceAuthDependency('monitor:job:edit')],
) )
@ValidateFields(validate_model='edit_job') @ValidateFields(validate_model='edit_job')
@@ -90,6 +93,7 @@ async def edit_system_job(
@job_controller.put( @job_controller.put(
'/job/changeStatus', '/job/changeStatus',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')], dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')],
) )
@Log(title='定时任务', business_type=BusinessType.UPDATE) @Log(title='定时任务', business_type=BusinessType.UPDATE)
@@ -114,6 +118,7 @@ async def change_system_job_status(
@job_controller.put( @job_controller.put(
'/job/run', '/job/run',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')], dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')],
) )
@Log(title='定时任务', business_type=BusinessType.UPDATE) @Log(title='定时任务', business_type=BusinessType.UPDATE)
@@ -130,6 +135,7 @@ async def execute_system_job(
@job_controller.delete( @job_controller.delete(
'/job/{job_ids}', '/job/{job_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
) )
@Log(title='定时任务', business_type=BusinessType.DELETE) @Log(title='定时任务', business_type=BusinessType.DELETE)
@@ -147,7 +153,7 @@ async def delete_system_job(
@job_controller.get( @job_controller.get(
'/job/{job_id}', '/job/{job_id}',
response_model=JobModel, response_model=DataResponseModel[JobModel],
dependencies=[UserInterfaceAuthDependency('monitor:job:query')], dependencies=[UserInterfaceAuthDependency('monitor:job:query')],
) )
async def query_detail_system_job( async def query_detail_system_job(
@@ -181,7 +187,7 @@ async def export_system_job_list(
@job_controller.get( @job_controller.get(
'/jobLog/list', '/jobLog/list',
response_model=PageResponseModel, response_model=PageResponseModel[JobLogModel],
dependencies=[UserInterfaceAuthDependency('monitor:job:list')], dependencies=[UserInterfaceAuthDependency('monitor:job:list')],
) )
async def get_system_job_log_list( async def get_system_job_log_list(
@@ -200,6 +206,7 @@ async def get_system_job_log_list(
@job_controller.delete( @job_controller.delete(
'/jobLog/clean', '/jobLog/clean',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
) )
@Log(title='定时任务调度日志', business_type=BusinessType.CLEAN) @Log(title='定时任务调度日志', business_type=BusinessType.CLEAN)
@@ -215,6 +222,7 @@ async def clear_system_job_log(
@job_controller.delete( @job_controller.delete(
'/jobLog/{job_log_ids}', '/jobLog/{job_log_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:job:remove')], dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
) )
@Log(title='定时任务调度日志', business_type=BusinessType.DELETE) @Log(title='定时任务调度日志', business_type=BusinessType.DELETE)
@@ -8,17 +8,19 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import PreAuthDependency from common.aspect.pre_auth import PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.log_vo import ( from module_admin.entity.vo.log_vo import (
DeleteLoginLogModel, DeleteLoginLogModel,
DeleteOperLogModel, DeleteOperLogModel,
LogininforModel,
LoginLogPageQueryModel, LoginLogPageQueryModel,
OperLogModel,
OperLogPageQueryModel, OperLogPageQueryModel,
UnlockUser, UnlockUser,
) )
from module_admin.service.log_service import LoginLogService, OperationLogService from module_admin.service.log_service import LoginLogService, OperationLogService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
log_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]) log_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()])
@@ -26,7 +28,7 @@ log_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]
@log_controller.get( @log_controller.get(
'/operlog/list', '/operlog/list',
response_model=PageResponseModel, response_model=PageResponseModel[OperLogModel],
dependencies=[UserInterfaceAuthDependency('monitor:operlog:list')], dependencies=[UserInterfaceAuthDependency('monitor:operlog:list')],
) )
async def get_system_operation_log_list( async def get_system_operation_log_list(
@@ -45,6 +47,7 @@ async def get_system_operation_log_list(
@log_controller.delete( @log_controller.delete(
'/operlog/clean', '/operlog/clean',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')], dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')],
) )
@Log(title='操作日志', business_type=BusinessType.CLEAN) @Log(title='操作日志', business_type=BusinessType.CLEAN)
@@ -59,6 +62,7 @@ async def clear_system_operation_log(
@log_controller.delete( @log_controller.delete(
'/operlog/{oper_ids}', '/operlog/{oper_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')], dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')],
) )
@Log(title='操作日志', business_type=BusinessType.DELETE) @Log(title='操作日志', business_type=BusinessType.DELETE)
@@ -100,7 +104,7 @@ async def export_system_operation_log_list(
@log_controller.get( @log_controller.get(
'/logininfor/list', '/logininfor/list',
response_model=PageResponseModel, response_model=PageResponseModel[LogininforModel],
dependencies=[UserInterfaceAuthDependency('monitor:logininfor:list')], dependencies=[UserInterfaceAuthDependency('monitor:logininfor:list')],
) )
async def get_system_login_log_list( async def get_system_login_log_list(
@@ -119,6 +123,7 @@ async def get_system_login_log_list(
@log_controller.delete( @log_controller.delete(
'/logininfor/clean', '/logininfor/clean',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')], dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')],
) )
@Log(title='登录日志', business_type=BusinessType.CLEAN) @Log(title='登录日志', business_type=BusinessType.CLEAN)
@@ -133,6 +138,7 @@ async def clear_system_login_log(
@log_controller.delete( @log_controller.delete(
'/logininfor/{info_ids}', '/logininfor/{info_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')], dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')],
) )
@Log(title='登录日志', business_type=BusinessType.DELETE) @Log(title='登录日志', business_type=BusinessType.DELETE)
@@ -150,6 +156,7 @@ async def delete_system_login_log(
@log_controller.get( @log_controller.get(
'/logininfor/unlock/{user_name}', '/logininfor/unlock/{user_name}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:logininfor:unlock')], dependencies=[UserInterfaceAuthDependency('monitor:logininfor:unlock')],
) )
@Log(title='账户解锁', business_type=BusinessType.OTHER) @Log(title='账户解锁', business_type=BusinessType.OTHER)
@@ -10,11 +10,11 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.notice_vo import DeleteNoticeModel, NoticeModel, NoticePageQueryModel from module_admin.entity.vo.notice_vo import DeleteNoticeModel, NoticeModel, NoticePageQueryModel
from module_admin.entity.vo.user_vo import CurrentUserModel from module_admin.entity.vo.user_vo import CurrentUserModel
from module_admin.service.notice_service import NoticeService from module_admin.service.notice_service import NoticeService
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
notice_controller = APIRouter(prefix='/system/notice', dependencies=[PreAuthDependency()]) notice_controller = APIRouter(prefix='/system/notice', dependencies=[PreAuthDependency()])
@@ -22,7 +22,7 @@ notice_controller = APIRouter(prefix='/system/notice', dependencies=[PreAuthDepe
@notice_controller.get( @notice_controller.get(
'/list', '/list',
response_model=PageResponseModel, response_model=PageResponseModel[NoticeModel],
dependencies=[UserInterfaceAuthDependency('system:notice:list')], dependencies=[UserInterfaceAuthDependency('system:notice:list')],
) )
async def get_system_notice_list( async def get_system_notice_list(
@@ -39,6 +39,7 @@ async def get_system_notice_list(
@notice_controller.post( @notice_controller.post(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:notice:add')], dependencies=[UserInterfaceAuthDependency('system:notice:add')],
) )
@ValidateFields(validate_model='add_notice') @ValidateFields(validate_model='add_notice')
@@ -61,6 +62,7 @@ async def add_system_notice(
@notice_controller.put( @notice_controller.put(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:notice:edit')], dependencies=[UserInterfaceAuthDependency('system:notice:edit')],
) )
@ValidateFields(validate_model='edit_notice') @ValidateFields(validate_model='edit_notice')
@@ -81,6 +83,7 @@ async def edit_system_notice(
@notice_controller.delete( @notice_controller.delete(
'/{notice_ids}', '/{notice_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:notice:remove')], dependencies=[UserInterfaceAuthDependency('system:notice:remove')],
) )
@Log(title='通知公告', business_type=BusinessType.DELETE) @Log(title='通知公告', business_type=BusinessType.DELETE)
@@ -98,7 +101,7 @@ async def delete_system_notice(
@notice_controller.get( @notice_controller.get(
'/{notice_id}', '/{notice_id}',
response_model=NoticeModel, response_model=DataResponseModel[NoticeModel],
dependencies=[UserInterfaceAuthDependency('system:notice:query')], dependencies=[UserInterfaceAuthDependency('system:notice:query')],
) )
async def query_detail_system_post( async def query_detail_system_post(
@@ -8,10 +8,10 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import PreAuthDependency from common.aspect.pre_auth import PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from module_admin.entity.vo.online_vo import DeleteOnlineModel, OnlineQueryModel from common.vo import PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.online_vo import DeleteOnlineModel, OnlineModel, OnlineQueryModel
from module_admin.service.online_service import OnlineService from module_admin.service.online_service import OnlineService
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
online_controller = APIRouter(prefix='/monitor/online', dependencies=[PreAuthDependency()]) online_controller = APIRouter(prefix='/monitor/online', dependencies=[PreAuthDependency()])
@@ -19,7 +19,7 @@ online_controller = APIRouter(prefix='/monitor/online', dependencies=[PreAuthDep
@online_controller.get( @online_controller.get(
'/list', '/list',
response_model=PageResponseModel, response_model=PageResponseModel[OnlineModel],
dependencies=[UserInterfaceAuthDependency('monitor:online:list')], dependencies=[UserInterfaceAuthDependency('monitor:online:list')],
) )
async def get_monitor_online_list( async def get_monitor_online_list(
@@ -37,6 +37,7 @@ async def get_monitor_online_list(
@online_controller.delete( @online_controller.delete(
'/{token_ids}', '/{token_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('monitor:online:forceLogout')], dependencies=[UserInterfaceAuthDependency('monitor:online:forceLogout')],
) )
@Log(title='在线用户', business_type=BusinessType.FORCE) @Log(title='在线用户', business_type=BusinessType.FORCE)
@@ -10,12 +10,12 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.post_vo import DeletePostModel, PostModel, PostPageQueryModel from module_admin.entity.vo.post_vo import DeletePostModel, PostModel, PostPageQueryModel
from module_admin.entity.vo.user_vo import CurrentUserModel from module_admin.entity.vo.user_vo import CurrentUserModel
from module_admin.service.post_service import PostService from module_admin.service.post_service import PostService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
post_controller = APIRouter(prefix='/system/post', dependencies=[PreAuthDependency()]) post_controller = APIRouter(prefix='/system/post', dependencies=[PreAuthDependency()])
@@ -23,7 +23,7 @@ post_controller = APIRouter(prefix='/system/post', dependencies=[PreAuthDependen
@post_controller.get( @post_controller.get(
'/list', '/list',
response_model=PageResponseModel, response_model=PageResponseModel[PostModel],
dependencies=[UserInterfaceAuthDependency('system:post:list')], dependencies=[UserInterfaceAuthDependency('system:post:list')],
) )
async def get_system_post_list( async def get_system_post_list(
@@ -40,6 +40,7 @@ async def get_system_post_list(
@post_controller.post( @post_controller.post(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:post:add')], dependencies=[UserInterfaceAuthDependency('system:post:add')],
) )
@ValidateFields(validate_model='add_post') @ValidateFields(validate_model='add_post')
@@ -62,6 +63,7 @@ async def add_system_post(
@post_controller.put( @post_controller.put(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:post:edit')], dependencies=[UserInterfaceAuthDependency('system:post:edit')],
) )
@ValidateFields(validate_model='edit_post') @ValidateFields(validate_model='edit_post')
@@ -82,6 +84,7 @@ async def edit_system_post(
@post_controller.delete( @post_controller.delete(
'/{post_ids}', '/{post_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:post:remove')], dependencies=[UserInterfaceAuthDependency('system:post:remove')],
) )
@Log(title='岗位管理', business_type=BusinessType.DELETE) @Log(title='岗位管理', business_type=BusinessType.DELETE)
@@ -99,7 +102,7 @@ async def delete_system_post(
@post_controller.get( @post_controller.get(
'/{post_id}', '/{post_id}',
response_model=PostModel, response_model=DataResponseModel[PostModel],
dependencies=[UserInterfaceAuthDependency('system:post:query')], dependencies=[UserInterfaceAuthDependency('system:post:query')],
) )
async def query_detail_system_post( async def query_detail_system_post(
@@ -11,15 +11,15 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, PageResponseModel, ResponseBaseModel
from module_admin.entity.vo.dept_vo import DeptModel from module_admin.entity.vo.dept_vo import DeptModel
from module_admin.entity.vo.role_vo import AddRoleModel, DeleteRoleModel, RoleModel, RolePageQueryModel from module_admin.entity.vo.role_vo import AddRoleModel, DeleteRoleModel, RoleModel, RolePageQueryModel
from module_admin.entity.vo.user_vo import CrudUserRoleModel, CurrentUserModel, UserRolePageQueryModel from module_admin.entity.vo.user_vo import CrudUserRoleModel, CurrentUserModel, UserModel, UserRolePageQueryModel
from module_admin.service.dept_service import DeptService from module_admin.service.dept_service import DeptService
from module_admin.service.role_service import RoleService from module_admin.service.role_service import RoleService
from module_admin.service.user_service import UserService from module_admin.service.user_service import UserService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
role_controller = APIRouter(prefix='/system/role', dependencies=[PreAuthDependency()]) role_controller = APIRouter(prefix='/system/role', dependencies=[PreAuthDependency()])
@@ -45,7 +45,7 @@ async def get_system_role_dept_tree(
@role_controller.get( @role_controller.get(
'/list', '/list',
response_model=PageResponseModel, response_model=PageResponseModel[RoleModel],
dependencies=[UserInterfaceAuthDependency('system:role:list')], dependencies=[UserInterfaceAuthDependency('system:role:list')],
) )
async def get_system_role_list( async def get_system_role_list(
@@ -64,6 +64,7 @@ async def get_system_role_list(
@role_controller.post( @role_controller.post(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:add')], dependencies=[UserInterfaceAuthDependency('system:role:add')],
) )
@ValidateFields(validate_model='add_role') @ValidateFields(validate_model='add_role')
@@ -86,6 +87,7 @@ async def add_system_role(
@role_controller.put( @role_controller.put(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@ValidateFields(validate_model='edit_role') @ValidateFields(validate_model='edit_role')
@@ -110,6 +112,7 @@ async def edit_system_role(
@role_controller.put( @role_controller.put(
'/dataScope', '/dataScope',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@Log(title='角色管理', business_type=BusinessType.GRANT) @Log(title='角色管理', business_type=BusinessType.GRANT)
@@ -139,6 +142,7 @@ async def edit_system_role_datascope(
@role_controller.delete( @role_controller.delete(
'/{role_ids}', '/{role_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:remove')], dependencies=[UserInterfaceAuthDependency('system:role:remove')],
) )
@Log(title='角色管理', business_type=BusinessType.DELETE) @Log(title='角色管理', business_type=BusinessType.DELETE)
@@ -164,7 +168,7 @@ async def delete_system_role(
@role_controller.get( @role_controller.get(
'/{role_id}', '/{role_id}',
response_model=RoleModel, response_model=DataResponseModel[RoleModel],
dependencies=[UserInterfaceAuthDependency('system:role:query')], dependencies=[UserInterfaceAuthDependency('system:role:query')],
) )
async def query_detail_system_role( async def query_detail_system_role(
@@ -205,6 +209,7 @@ async def export_system_role_list(
@role_controller.put( @role_controller.put(
'/changeStatus', '/changeStatus',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@Log(title='角色管理', business_type=BusinessType.UPDATE) @Log(title='角色管理', business_type=BusinessType.UPDATE)
@@ -233,7 +238,7 @@ async def reset_system_role_status(
@role_controller.get( @role_controller.get(
'/authUser/allocatedList', '/authUser/allocatedList',
response_model=PageResponseModel, response_model=PageResponseModel[UserModel],
dependencies=[UserInterfaceAuthDependency('system:role:list')], dependencies=[UserInterfaceAuthDependency('system:role:list')],
) )
async def get_system_allocated_user_list( async def get_system_allocated_user_list(
@@ -252,7 +257,7 @@ async def get_system_allocated_user_list(
@role_controller.get( @role_controller.get(
'/authUser/unallocatedList', '/authUser/unallocatedList',
response_model=PageResponseModel, response_model=PageResponseModel[UserModel],
dependencies=[UserInterfaceAuthDependency('system:role:list')], dependencies=[UserInterfaceAuthDependency('system:role:list')],
) )
async def get_system_unallocated_user_list( async def get_system_unallocated_user_list(
@@ -271,6 +276,7 @@ async def get_system_unallocated_user_list(
@role_controller.put( @role_controller.put(
'/authUser/selectAll', '/authUser/selectAll',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@Log(title='角色管理', business_type=BusinessType.GRANT) @Log(title='角色管理', business_type=BusinessType.GRANT)
@@ -291,6 +297,7 @@ async def add_system_role_user(
@role_controller.put( @role_controller.put(
'/authUser/cancel', '/authUser/cancel',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@Log(title='角色管理', business_type=BusinessType.GRANT) @Log(title='角色管理', business_type=BusinessType.GRANT)
@@ -307,6 +314,7 @@ async def cancel_system_role_user(
@role_controller.put( @role_controller.put(
'/authUser/cancelAll', '/authUser/cancelAll',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:role:edit')], dependencies=[UserInterfaceAuthDependency('system:role:edit')],
) )
@Log(title='角色管理', business_type=BusinessType.GRANT) @Log(title='角色管理', business_type=BusinessType.GRANT)
@@ -13,6 +13,7 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import UserInterfaceAuthDependency from common.aspect.interface_auth import UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import DataResponseModel, DynamicResponseModel, PageResponseModel, ResponseBaseModel
from config.env import UploadConfig from config.env import UploadConfig
from module_admin.entity.vo.dept_vo import DeptModel from module_admin.entity.vo.dept_vo import DeptModel
from module_admin.entity.vo.user_vo import ( from module_admin.entity.vo.user_vo import (
@@ -36,7 +37,6 @@ from module_admin.service.role_service import RoleService
from module_admin.service.user_service import UserService from module_admin.service.user_service import UserService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.pwd_util import PwdUtil from utils.pwd_util import PwdUtil
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
from utils.upload_util import UploadUtil from utils.upload_util import UploadUtil
@@ -81,6 +81,7 @@ async def get_system_user_list(
@user_controller.post( @user_controller.post(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:add')], dependencies=[UserInterfaceAuthDependency('system:user:add')],
) )
@ValidateFields(validate_model='add_user') @ValidateFields(validate_model='add_user')
@@ -111,6 +112,7 @@ async def add_system_user(
@user_controller.put( @user_controller.put(
'', '',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:edit')], dependencies=[UserInterfaceAuthDependency('system:user:edit')],
) )
@ValidateFields(validate_model='edit_user') @ValidateFields(validate_model='edit_user')
@@ -141,6 +143,7 @@ async def edit_system_user(
@user_controller.delete( @user_controller.delete(
'/{user_ids}', '/{user_ids}',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:remove')], dependencies=[UserInterfaceAuthDependency('system:user:remove')],
) )
@Log(title='用户管理', business_type=BusinessType.DELETE) @Log(title='用户管理', business_type=BusinessType.DELETE)
@@ -170,6 +173,7 @@ async def delete_system_user(
@user_controller.put( @user_controller.put(
'/resetPwd', '/resetPwd',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:resetPwd')], dependencies=[UserInterfaceAuthDependency('system:user:resetPwd')],
) )
@Log(title='用户管理', business_type=BusinessType.UPDATE) @Log(title='用户管理', business_type=BusinessType.UPDATE)
@@ -199,6 +203,7 @@ async def reset_system_user_pwd(
@user_controller.put( @user_controller.put(
'/changeStatus', '/changeStatus',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:edit')], dependencies=[UserInterfaceAuthDependency('system:user:edit')],
) )
@Log(title='用户管理', business_type=BusinessType.UPDATE) @Log(title='用户管理', business_type=BusinessType.UPDATE)
@@ -225,7 +230,10 @@ async def change_system_user_status(
return ResponseUtil.success(msg=edit_user_result.message) return ResponseUtil.success(msg=edit_user_result.message)
@user_controller.get('/profile', response_model=UserProfileModel) @user_controller.get(
'/profile',
response_model=DynamicResponseModel[UserProfileModel],
)
async def query_detail_system_user_profile( async def query_detail_system_user_profile(
request: Request, request: Request,
query_db: Annotated[AsyncSession, DBSessionDependency()], query_db: Annotated[AsyncSession, DBSessionDependency()],
@@ -239,7 +247,7 @@ async def query_detail_system_user_profile(
@user_controller.get( @user_controller.get(
'/{user_id}', '/{user_id}',
response_model=UserDetailModel, response_model=DataResponseModel[UserDetailModel],
dependencies=[UserInterfaceAuthDependency('system:user:query')], dependencies=[UserInterfaceAuthDependency('system:user:query')],
) )
@user_controller.get( @user_controller.get(
@@ -297,7 +305,10 @@ async def change_system_user_profile_avatar(
return ResponseUtil.failure(msg='上传图片异常,请联系管理员') return ResponseUtil.failure(msg='上传图片异常,请联系管理员')
@user_controller.put('/profile') @user_controller.put(
'/profile',
response_model=ResponseBaseModel,
)
@Log(title='个人信息', business_type=BusinessType.UPDATE) @Log(title='个人信息', business_type=BusinessType.UPDATE)
async def change_system_user_profile_info( async def change_system_user_profile_info(
request: Request, request: Request,
@@ -321,7 +332,10 @@ async def change_system_user_profile_info(
return ResponseUtil.success(msg=edit_user_result.message) return ResponseUtil.success(msg=edit_user_result.message)
@user_controller.put('/profile/updatePwd') @user_controller.put(
'/profile/updatePwd',
response_model=ResponseBaseModel,
)
@Log(title='个人信息', business_type=BusinessType.UPDATE) @Log(title='个人信息', business_type=BusinessType.UPDATE)
async def reset_system_user_password( async def reset_system_user_password(
request: Request, request: Request,
@@ -345,6 +359,7 @@ async def reset_system_user_password(
@user_controller.post( @user_controller.post(
'/importData', '/importData',
response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:import')], dependencies=[UserInterfaceAuthDependency('system:user:import')],
) )
@Log(title='用户管理', business_type=BusinessType.IMPORT) @Log(title='用户管理', business_type=BusinessType.IMPORT)
@@ -401,7 +416,7 @@ async def export_system_user_list(
@user_controller.get( @user_controller.get(
'/authRole/{user_id}', '/authRole/{user_id}',
response_model=UserRoleResponseModel, response_model=DynamicResponseModel[UserRoleResponseModel],
dependencies=[UserInterfaceAuthDependency('system:user:query')], dependencies=[UserInterfaceAuthDependency('system:user:query')],
) )
async def get_system_allocated_role_list( async def get_system_allocated_role_list(
@@ -420,7 +435,7 @@ async def get_system_allocated_role_list(
@user_controller.put( @user_controller.put(
'/authRole', '/authRole',
response_model=UserRoleResponseModel, response_model=ResponseBaseModel,
dependencies=[UserInterfaceAuthDependency('system:user:edit')], dependencies=[UserInterfaceAuthDependency('system:user:edit')],
) )
@Log(title='用户管理', business_type=BusinessType.GRANT) @Log(title='用户管理', business_type=BusinessType.GRANT)
@@ -10,13 +10,13 @@ from common.aspect.db_seesion import DBSessionDependency
from common.aspect.interface_auth import RoleInterfaceAuthDependency, UserInterfaceAuthDependency from common.aspect.interface_auth import RoleInterfaceAuthDependency, UserInterfaceAuthDependency
from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency from common.aspect.pre_auth import CurrentUserDependency, PreAuthDependency
from common.enums import BusinessType from common.enums import BusinessType
from common.vo import PageResponseModel
from config.env import GenConfig from config.env import GenConfig
from module_admin.entity.vo.user_vo import CurrentUserModel from module_admin.entity.vo.user_vo import CurrentUserModel
from module_generator.entity.vo.gen_vo import DeleteGenTableModel, EditGenTableModel, GenTablePageQueryModel from module_generator.entity.vo.gen_vo import DeleteGenTableModel, EditGenTableModel, GenTablePageQueryModel
from module_generator.service.gen_service import GenTableColumnService, GenTableService from module_generator.service.gen_service import GenTableColumnService, GenTableService
from utils.common_util import bytes2file_response from utils.common_util import bytes2file_response
from utils.log_util import logger from utils.log_util import logger
from utils.page_util import PageResponseModel
from utils.response_util import ResponseUtil from utils.response_util import ResponseUtil
gen_controller = APIRouter(prefix='/tool/gen', dependencies=[PreAuthDependency()]) gen_controller = APIRouter(prefix='/tool/gen', dependencies=[PreAuthDependency()])