perf: 接口API文档的接口描述信息

ruoyi-fastapi-backend/module_admin/controller/cache_controller.py

@@ -15,6 +15,8 @@ cache_controller = APIRouter(prefix='/monitor/cache', dependencies=[PreAuthDepen
 
 @cache_controller.get(
     '',
+    summary='获取缓存监控信息接口',
+    description='用于获取缓存监控信息',
     response_model=DataResponseModel[CacheMonitorModel],
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
@@ -28,6 +30,8 @@ async def get_monitor_cache_info(request: Request) -> Response:
 
 @cache_controller.get(
     '/getNames',
+    summary='获取缓存名称列表接口',
+    description='用于获取缓存名称列表',
     response_model=DataResponseModel[list[CacheInfoModel]],
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
@@ -41,6 +45,8 @@ async def get_monitor_cache_name(request: Request) -> Response:
 
 @cache_controller.get(
     '/getKeys/{cache_name}',
+    summary='获取缓存键列表接口',
+    description='用于获取指定缓存名称下的所有缓存键列表',
     response_model=DataResponseModel[list[str]],
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
@@ -54,6 +60,8 @@ async def get_monitor_cache_key(request: Request, cache_name: Annotated[str, Pat
 
 @cache_controller.get(
     '/getValue/{cache_name}/{cache_key}',
+    summary='获取缓存值接口',
+    description='用于获取指定缓存名称下的指定缓存键对应的值',
     response_model=DataResponseModel[CacheInfoModel],
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
@@ -71,6 +79,9 @@ async def get_monitor_cache_value(
 
 @cache_controller.delete(
     '/clearCacheName/{cache_name}',
+    summary='清除缓存名称接口',
+    description='用于清除指定缓存名称下的所有缓存键值对',
+    response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
 async def clear_monitor_cache_name(
@@ -84,7 +95,9 @@ async def clear_monitor_cache_name(
 
 @cache_controller.delete(
     '/clearCacheKey/{cache_key}',
-    response_model= ResponseBaseModel,
+    summary='清除缓存键接口',
+    description='用于清除指定缓存键对应的值',
+    response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
 async def clear_monitor_cache_key(request: Request, cache_key: Annotated[str, Path(description='缓存键')]) -> Response:
@@ -96,7 +109,9 @@ async def clear_monitor_cache_key(request: Request, cache_key: Annotated[str, Pa
 
 @cache_controller.delete(
     '/clearCacheAll',
-    response_model= ResponseBaseModel,
+    summary='清除所有缓存接口',
+    description='用于清除所有缓存键值对',
+    response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:cache:list')],
 )
 async def clear_monitor_cache_all(request: Request) -> Response:

ruoyi-fastapi-backend/module_admin/controller/captcha_controller.py

@@ -15,6 +15,8 @@ captcha_controller = APIRouter()
 
 @captcha_controller.get(
     '/captchaImage',
+    summary='获取图片验证码接口',
+    description='用于获取图片验证码',
     response_model=DynamicResponseModel[CaptchaCode],
 )
 async def get_captcha_image(request: Request) -> Response:

ruoyi-fastapi-backend/module_admin/controller/common_controller.py

@@ -15,6 +15,8 @@ common_controller = APIRouter(prefix='/common', dependencies=[PreAuthDependency(
 
 @common_controller.post(
     '/upload',
+    summary='通用文件上传接口',
+    description='用于上传文件',
     response_model=DynamicResponseModel[UploadResponseModel],
 )
 async def common_upload(request: Request, file: Annotated[UploadFile, File(...)]) -> Response:
@@ -26,6 +28,8 @@ async def common_upload(request: Request, file: Annotated[UploadFile, File(...)]
 
 @common_controller.get(
     '/download',
+    summary='通用文件下载接口',
+    description='用于下载下载目录中的文件',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -50,6 +54,8 @@ async def common_download(
 
 @common_controller.get(
     '/download/resource',
+    summary='通用资源文件下载接口',
+    description='用于下载上传目录中的资源文件',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/config_controller.py

@@ -24,6 +24,8 @@ config_controller = APIRouter(prefix='/system/config', dependencies=[PreAuthDepe
 
 @config_controller.get(
     '/list',
+    summary='获取参数分页列表接口',
+    description='用于获取参数分页列表',
     response_model=PageResponseModel[ConfigModel],
     dependencies=[UserInterfaceAuthDependency('system:config:list')],
 )
@@ -41,6 +43,8 @@ async def get_system_config_list(
 
 @config_controller.post(
     '',
+    summary='新增参数接口',
+    description='用于新增参数',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:config:add')],
 )
@@ -64,6 +68,8 @@ async def add_system_config(
 
 @config_controller.put(
     '',
+    summary='编辑参数接口',
+    description='用于编辑参数',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:config:edit')],
 )
@@ -85,6 +91,8 @@ async def edit_system_config(
 
 @config_controller.delete(
     '/refreshCache',
+    summary='刷新参数缓存接口',
+    description='用于刷新参数缓存',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:config:remove')],
 )
@@ -101,6 +109,8 @@ async def refresh_system_config(
 
 @config_controller.delete(
     '/{config_ids}',
+    summary='删除参数接口',
+    description='用于删除参数',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:config:remove')],
 )
@@ -119,6 +129,8 @@ async def delete_system_config(
 
 @config_controller.get(
     '/{config_id}',
+    summary='获取参数详情接口',
+    description='用于获取指定参数的详细信息',
     response_model=DataResponseModel[ConfigModel],
     dependencies=[UserInterfaceAuthDependency('system:config:query')],
 )
@@ -135,6 +147,8 @@ async def query_detail_system_config(
 
 @config_controller.get(
     '/configKey/{config_key}',
+    summary='根据参数键查询参数值接口',
+    description='用于根据参数键从缓存中查询参数值',
     response_model=ResponseBaseModel,
 )
 async def query_system_config(request: Request, config_key: str) -> Response:
@@ -147,6 +161,8 @@ async def query_system_config(request: Request, config_key: str) -> Response:
 
 @config_controller.post(
     '/export',
+    summary='导出参数列表接口',
+    description='用于导出当前符合查询条件的参数列表数据',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/dept_controller.py

@@ -23,6 +23,8 @@ dept_controller = APIRouter(prefix='/system/dept', dependencies=[PreAuthDependen
 
 @dept_controller.get(
     '/list/exclude/{dept_id}',
+    summary='获取编辑部门的下拉树接口',
+    description='用于获取部门下拉树，不包含指定部门及其子部门',
     response_model=DataResponseModel[list[DeptModel]],
     dependencies=[UserInterfaceAuthDependency('system:dept:list')],
 )
@@ -41,6 +43,8 @@ async def get_system_dept_tree_for_edit_option(
 
 @dept_controller.get(
     '/list',
+    summary='获取部门列表接口',
+    description='用于获取部门列表',
     response_model=DataResponseModel[list[DeptModel]],
     dependencies=[UserInterfaceAuthDependency('system:dept:list')],
 )
@@ -58,6 +62,8 @@ async def get_system_dept_list(
 
 @dept_controller.post(
     '',
+    summary='新增部门接口',
+    description='用于新增部门',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dept:add')],
 )
@@ -81,6 +87,8 @@ async def add_system_dept(
 
 @dept_controller.put(
     '',
+    summary='编辑部门接口',
+    description='用于编辑部门',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dept:edit')],
 )
@@ -105,6 +113,8 @@ async def edit_system_dept(
 
 @dept_controller.delete(
     '/{dept_ids}',
+    summary='删除部门接口',
+    description='用于删除部门',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dept:remove')],
 )
@@ -132,6 +142,8 @@ async def delete_system_dept(
 
 @dept_controller.get(
     '/{dept_id}',
+    summary='获取部门详情接口',
+    description='用于获取指定部门的详情信息',
     response_model=DataResponseModel[DeptModel],
     dependencies=[UserInterfaceAuthDependency('system:dept:query')],
 )

ruoyi-fastapi-backend/module_admin/controller/dict_controller.py

@@ -31,6 +31,8 @@ dict_controller = APIRouter(prefix='/system/dict', dependencies=[PreAuthDependen
 
 @dict_controller.get(
     '/type/list',
+    summary='获取字典类型分页列表接口',
+    description='用于获取字典类型分页列表',
     response_model=PageResponseModel[DictTypeModel],
     dependencies=[UserInterfaceAuthDependency('system:dict:list')],
 )
@@ -50,6 +52,8 @@ async def get_system_dict_type_list(
 
 @dict_controller.post(
     '/type',
+    summary='新增字典类型接口',
+    description='用于新增字典类型',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:add')],
 )
@@ -73,6 +77,8 @@ async def add_system_dict_type(
 
 @dict_controller.put(
     '/type',
+    summary='编辑字典类型接口',
+    description='用于编辑字典类型',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:edit')],
 )
@@ -94,6 +100,8 @@ async def edit_system_dict_type(
 
 @dict_controller.delete(
     '/type/refreshCache',
+    summary='刷新字典缓存接口',
+    description='用于刷新字典缓存',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
 )
@@ -107,6 +115,8 @@ async def refresh_system_dict(request: Request, query_db: Annotated[AsyncSession
 
 @dict_controller.delete(
     '/type/{dict_ids}',
+    summary='删除字典类型接口',
+    description='用于删除字典类型',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
 )
@@ -125,6 +135,8 @@ async def delete_system_dict_type(
 
 @dict_controller.get(
     '/type/optionselect',
+    summary='获取字典类型下拉列表接口',
+    description='用于获取字典类型下拉列表',
     response_model=DataResponseModel[list[DictTypeModel]],
 )
 async def query_system_dict_type_options(
@@ -140,6 +152,8 @@ async def query_system_dict_type_options(
 
 @dict_controller.get(
     '/type/{dict_id}',
+    summary='获取字典类型详情接口',
+    description='用于获取指定字典类型的详细信息',
     response_model=DataResponseModel[DictTypeModel],
     dependencies=[UserInterfaceAuthDependency('system:dict:query')],
 )
@@ -156,6 +170,8 @@ async def query_detail_system_dict_type(
 
 @dict_controller.post(
     '/type/export',
+    summary='导出字典类型列表接口',
+    description='用于导出当前符合查询条件的字典类型列表数据',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -185,6 +201,8 @@ async def export_system_dict_type_list(
 
 @dict_controller.get(
     '/data/type/{dict_type}',
+    summary='获取指定字典类型的数据列表接口',
+    description='用于从缓存中获取指定字典类型的所有数据项',
     response_model=DataResponseModel[list[DictDataModel]],
 )
 async def query_system_dict_type_data(
@@ -203,6 +221,8 @@ async def query_system_dict_type_data(
 
 @dict_controller.get(
     '/data/list',
+    summary='获取字典数据分页列表接口',
+    description='用于获取字典数据分页列表',
     response_model=PageResponseModel[DictDataModel],
     dependencies=[UserInterfaceAuthDependency('system:dict:list')],
 )
@@ -222,6 +242,8 @@ async def get_system_dict_data_list(
 
 @dict_controller.post(
     '/data',
+    summary='新增字典数据接口',
+    description='用于新增字典数据',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:add')],
 )
@@ -245,6 +267,8 @@ async def add_system_dict_data(
 
 @dict_controller.put(
     '/data',
+    summary='编辑字典数据接口',
+    description='用于编辑字典数据',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:edit')],
 )
@@ -266,6 +290,8 @@ async def edit_system_dict_data(
 
 @dict_controller.delete(
     '/data/{dict_codes}',
+    summary='删除字典数据接口',
+    description='用于删除字典数据',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:dict:remove')],
 )
@@ -284,6 +310,8 @@ async def delete_system_dict_data(
 
 @dict_controller.get(
     '/data/{dict_code}',
+    summary='获取字典数据详情接口',
+    description='用于获取指定字典数据的详细信息',
     response_model=DataResponseModel[DictDataModel],
     dependencies=[UserInterfaceAuthDependency('system:dict:query')],
 )
@@ -300,6 +328,8 @@ async def query_detail_system_dict_data(
 
 @dict_controller.post(
     '/data/export',
+    summary='导出字典数据列表接口',
+    description='用于导出当前符合查询条件的字典数据列表数据',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/job_controller.py

@@ -33,6 +33,8 @@ job_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]
 
 @job_controller.get(
     '/job/list',
+    summary='获取定时任务分页列表接口',
+    description='用于获取定时任务分页列表',
     response_model=PageResponseModel[JobModel],
     dependencies=[UserInterfaceAuthDependency('monitor:job:list')],
 )
@@ -50,6 +52,8 @@ async def get_system_job_list(
 
 @job_controller.post(
     '/job',
+    summary='新增定时任务接口',
+    description='用于新增定时任务',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:add')],
 )
@@ -73,6 +77,8 @@ async def add_system_job(
 
 @job_controller.put(
     '/job',
+    summary='编辑定时任务接口',
+    description='用于编辑定时任务',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:edit')],
 )
@@ -94,6 +100,8 @@ async def edit_system_job(
 
 @job_controller.put(
     '/job/changeStatus',
+    summary='修改定时任务状态接口',
+    description='用于修改定时任务状态',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')],
 )
@@ -119,6 +127,8 @@ async def change_system_job_status(
 
 @job_controller.put(
     '/job/run',
+    summary='执行定时任务接口',
+    description='用于执行指定的定时任务',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:changeStatus')],
 )
@@ -136,6 +146,8 @@ async def execute_system_job(
 
 @job_controller.delete(
     '/job/{job_ids}',
+    summary='删除定时任务接口',
+    description='用于删除定时任务',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
 )
@@ -154,6 +166,8 @@ async def delete_system_job(
 
 @job_controller.get(
     '/job/{job_id}',
+    summary='获取定时任务详情接口',
+    description='用于获取指定定时任务的详情信息',
     response_model=DataResponseModel[JobModel],
     dependencies=[UserInterfaceAuthDependency('monitor:job:query')],
 )
@@ -170,6 +184,8 @@ async def query_detail_system_job(
 
 @job_controller.post(
     '/job/export',
+    summary='导出定时任务列表接口',
+    description='用于导出当前符合查询条件的定时任务列表数据',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -197,6 +213,8 @@ async def export_system_job_list(
 
 @job_controller.get(
     '/jobLog/list',
+    summary='获取定时任务调度日志分页列表接口',
+    description='用于获取定时任务调度日志分页列表',
     response_model=PageResponseModel[JobLogModel],
     dependencies=[UserInterfaceAuthDependency('monitor:job:list')],
 )
@@ -216,6 +234,8 @@ async def get_system_job_log_list(
 
 @job_controller.delete(
     '/jobLog/clean',
+    summary='清空定时任务调度日志接口',
+    description='用于清空所有定时任务调度日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
 )
@@ -232,6 +252,8 @@ async def clear_system_job_log(
 
 @job_controller.delete(
     '/jobLog/{job_log_ids}',
+    summary='删除定时任务调度日志接口',
+    description='用于删除定时任务调度日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:job:remove')],
 )
@@ -250,6 +272,8 @@ async def delete_system_job_log(
 
 @job_controller.post(
     '/jobLog/export',
+    summary='导出定时任务调度日志列表接口',
+    description='用于导出当前符合查询条件的定时任务调度日志列表数据',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/log_controller.py

@@ -29,6 +29,8 @@ log_controller = APIRouter(prefix='/monitor', dependencies=[PreAuthDependency()]
 
 @log_controller.get(
     '/operlog/list',
+    summary='获取操作日志分页列表接口',
+    description='用于获取操作日志分页列表',
     response_model=PageResponseModel[OperLogModel],
     dependencies=[UserInterfaceAuthDependency('monitor:operlog:list')],
 )
@@ -48,6 +50,8 @@ async def get_system_operation_log_list(
 
 @log_controller.delete(
     '/operlog/clean',
+    summary='清空操作日志接口',
+    description='用于清空所有操作日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')],
 )
@@ -63,6 +67,8 @@ async def clear_system_operation_log(
 
 @log_controller.delete(
     '/operlog/{oper_ids}',
+    summary='删除操作日志接口',
+    description='用于删除操作日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:operlog:remove')],
 )
@@ -83,6 +89,8 @@ async def delete_system_operation_log(
 
 @log_controller.post(
     '/operlog/export',
+    summary='导出操作日志接口',
+    description='用于导出当前符合查询条件的操作日志数据',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -114,6 +122,8 @@ async def export_system_operation_log_list(
 
 @log_controller.get(
     '/logininfor/list',
+    summary='获取登录日志分页列表接口',
+    description='用于获取登录日志分页列表',
     response_model=PageResponseModel[LogininforModel],
     dependencies=[UserInterfaceAuthDependency('monitor:logininfor:list')],
 )
@@ -133,6 +143,8 @@ async def get_system_login_log_list(
 
 @log_controller.delete(
     '/logininfor/clean',
+    summary='清空登录日志接口',
+    description='用于清空所有登录日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')],
 )
@@ -148,6 +160,8 @@ async def clear_system_login_log(
 
 @log_controller.delete(
     '/logininfor/{info_ids}',
+    summary='删除登录日志接口',
+    description='用于删除登录日志',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:logininfor:remove')],
 )
@@ -166,6 +180,8 @@ async def delete_system_login_log(
 
 @log_controller.get(
     '/logininfor/unlock/{user_name}',
+    summary='解锁账户接口',
+    description='用于解锁指定用户账户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:logininfor:unlock')],
 )
@@ -184,6 +200,8 @@ async def unlock_system_user(
 
 @log_controller.post(
     '/logininfor/export',
+    summary='导出登录日志接口',
+    description='用于导出当前符合查询条件的登录日志数据',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/login_controller.py

@@ -24,6 +24,8 @@ login_controller = APIRouter()
 
 @login_controller.post(
     '/login',
+    summary='登录接口',
+    description='用于用户登录',
     response_model=DynamicResponseModel[Token],
 )
 @Log(title='用户登录', business_type=BusinessType.OTHER, log_type='login')
@@ -83,6 +85,8 @@ async def login(
 
 @login_controller.get(
     '/getInfo',
+    summary='获取用户信息接口',
+    description='用于获取当前登录用户的信息',
     response_model=DynamicResponseModel[CurrentUserModel],
 )
 async def get_login_user_info(
@@ -95,6 +99,8 @@ async def get_login_user_info(
 
 @login_controller.get(
     '/getRouters',
+    summary='获取用户路由接口',
+    description='用于获取当前登录用户的路由信息',
     response_model=DataResponseModel[list[RouterModel]],
 )
 async def get_login_user_routers(
@@ -110,6 +116,8 @@ async def get_login_user_routers(
 
 @login_controller.post(
     '/register',
+    summary='注册接口',
+    description='用于用户注册',
     response_model=DataResponseModel[CrudResponseModel],
 )
 async def register_user(
@@ -155,6 +163,8 @@ async def register_user(
 
 @login_controller.post(
     '/logout',
+    summary='退出登录接口',
+    description='用于用户退出登录',
     response_model=ResponseBaseModel,
 )
 async def logout(request: Request, token: Annotated[Optional[str], Depends(oauth2_scheme)]) -> Response:

ruoyi-fastapi-backend/module_admin/controller/menu_controller.py

@@ -23,6 +23,8 @@ menu_controller = APIRouter(prefix='/system/menu', dependencies=[PreAuthDependen
 
 @menu_controller.get(
     '/treeselect',
+    summary='获取菜单树接口',
+    description='用于获取当前用户可见的菜单树',
     response_model=DataResponseModel[list[MenuTreeModel]],
 )
 async def get_system_menu_tree(
@@ -38,6 +40,8 @@ async def get_system_menu_tree(
 
 @menu_controller.get(
     '/roleMenuTreeselect/{role_id}',
+    summary='获取角色菜单树接口',
+    description='用于获取指定角色可见的菜单树',
     response_model=DynamicResponseModel[RoleMenuQueryModel],
 )
 async def get_system_role_menu_tree(
@@ -54,6 +58,8 @@ async def get_system_role_menu_tree(
 
 @menu_controller.get(
     '/list',
+    summary='获取菜单列表接口',
+    description='用于获取当前用户可见的菜单列表',
     response_model=DataResponseModel[list[MenuModel]],
     dependencies=[UserInterfaceAuthDependency('system:menu:list')],
 )
@@ -71,6 +77,8 @@ async def get_system_menu_list(
 
 @menu_controller.post(
     '',
+    summary='新增菜单接口',
+    description='用于新增菜单',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:menu:add')],
 )
@@ -94,6 +102,8 @@ async def add_system_menu(
 
 @menu_controller.put(
     '',
+    summary='编辑菜单接口',
+    description='用于编辑菜单',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:menu:edit')],
 )
@@ -115,6 +125,8 @@ async def edit_system_menu(
 
 @menu_controller.delete(
     '/{menu_ids}',
+    summary='删除菜单接口',
+    description='用于删除菜单',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:menu:remove')],
 )
@@ -133,6 +145,8 @@ async def delete_system_menu(
 
 @menu_controller.get(
     '/{menu_id}',
+    summary='获取菜单详情接口',
+    description='用于获取指定菜单的详情信息',
     response_model=DataResponseModel[MenuModel],
     dependencies=[UserInterfaceAuthDependency('system:menu:query')],
 )

ruoyi-fastapi-backend/module_admin/controller/notice_controller.py

@@ -22,6 +22,8 @@ notice_controller = APIRouter(prefix='/system/notice', dependencies=[PreAuthDepe
 
 @notice_controller.get(
     '/list',
+    summary='获取通知公告分页列表接口',
+    description='用于获取通知公告分页列表',
     response_model=PageResponseModel[NoticeModel],
     dependencies=[UserInterfaceAuthDependency('system:notice:list')],
 )
@@ -39,6 +41,8 @@ async def get_system_notice_list(
 
 @notice_controller.post(
     '',
+    summary='新增通知公告接口',
+    description='用于新增通知公告',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:notice:add')],
 )
@@ -62,6 +66,8 @@ async def add_system_notice(
 
 @notice_controller.put(
     '',
+    summary='编辑通知公告接口',
+    description='用于编辑通知公告',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:notice:edit')],
 )
@@ -83,6 +89,8 @@ async def edit_system_notice(
 
 @notice_controller.delete(
     '/{notice_ids}',
+    summary='删除通知公告接口',
+    description='用于删除通知公告',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:notice:remove')],
 )
@@ -101,6 +109,8 @@ async def delete_system_notice(
 
 @notice_controller.get(
     '/{notice_id}',
+    summary='获取通知公告详情接口',
+    description='用于获取指定通知公告的详细信息',
     response_model=DataResponseModel[NoticeModel],
     dependencies=[UserInterfaceAuthDependency('system:notice:query')],
 )

ruoyi-fastapi-backend/module_admin/controller/online_controller.py

@@ -19,6 +19,8 @@ online_controller = APIRouter(prefix='/monitor/online', dependencies=[PreAuthDep
 
 @online_controller.get(
     '/list',
+    summary='获取在线用户分页列表接口',
+    description='用于获取在线用户分页列表',
     response_model=PageResponseModel[OnlineModel],
     dependencies=[UserInterfaceAuthDependency('monitor:online:list')],
 )
@@ -37,6 +39,8 @@ async def get_monitor_online_list(
 
 @online_controller.delete(
     '/{token_ids}',
+    summary='强退在线用户接口',
+    description='用于强退指定会话编号的在线用户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('monitor:online:forceLogout')],
 )

ruoyi-fastapi-backend/module_admin/controller/post_controller.py

@@ -24,6 +24,8 @@ post_controller = APIRouter(prefix='/system/post', dependencies=[PreAuthDependen
 
 @post_controller.get(
     '/list',
+    summary='获取岗位分页列表接口',
+    description='用于获取岗位分页列表',
     response_model=PageResponseModel[PostModel],
     dependencies=[UserInterfaceAuthDependency('system:post:list')],
 )
@@ -41,6 +43,8 @@ async def get_system_post_list(
 
 @post_controller.post(
     '',
+    summary='新增岗位接口',
+    description='用于新增岗位',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:post:add')],
 )
@@ -64,6 +68,8 @@ async def add_system_post(
 
 @post_controller.put(
     '',
+    summary='编辑岗位接口',
+    description='用于编辑岗位',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:post:edit')],
 )
@@ -85,6 +91,8 @@ async def edit_system_post(
 
 @post_controller.delete(
     '/{post_ids}',
+    summary='删除岗位接口',
+    description='用于删除岗位',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:post:remove')],
 )
@@ -103,6 +111,8 @@ async def delete_system_post(
 
 @post_controller.get(
     '/{post_id}',
+    summary='获取岗位详情接口',
+    description='用于获取指定岗位的详细信息',
     response_model=DataResponseModel[PostModel],
     dependencies=[UserInterfaceAuthDependency('system:post:query')],
 )
@@ -119,6 +129,8 @@ async def query_detail_system_post(
 
 @post_controller.post(
     '/export',
+    summary='导出岗位列表接口',
+    description='用于导出当前符合查询条件的岗位列表数据',
     response_class=StreamingResponse,
     responses={
         200: {

ruoyi-fastapi-backend/module_admin/controller/role_controller.py

@@ -34,6 +34,8 @@ role_controller = APIRouter(prefix='/system/role', dependencies=[PreAuthDependen
 
 @role_controller.get(
     '/deptTree/{role_id}',
+    summary='获取自定义数据权限时可见的部门树接口',
+    description='用于自定义数据权限时获取当前用户可见的部门树',
     response_model=DynamicResponseModel[RoleDeptQueryModel],
     dependencies=[UserInterfaceAuthDependency('system:role:query')],
 )
@@ -53,6 +55,8 @@ async def get_system_role_dept_tree(
 
 @role_controller.get(
     '/list',
+    summary='获取角色分页列表接口',
+    description='用于获取角色分页列表',
     response_model=PageResponseModel[RoleModel],
     dependencies=[UserInterfaceAuthDependency('system:role:list')],
 )
@@ -72,6 +76,8 @@ async def get_system_role_list(
 
 @role_controller.post(
     '',
+    summary='新增角色接口',
+    description='用于新增角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:add')],
 )
@@ -95,6 +101,8 @@ async def add_system_role(
 
 @role_controller.put(
     '',
+    summary='编辑角色接口',
+    description='用于编辑角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )
@@ -120,6 +128,8 @@ async def edit_system_role(
 
 @role_controller.put(
     '/dataScope',
+    summary='编辑角色数据权限接口',
+    description='用于编辑角色数据权限',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )
@@ -150,6 +160,8 @@ async def edit_system_role_datascope(
 
 @role_controller.delete(
     '/{role_ids}',
+    summary='删除角色接口',
+    description='用于删除角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:remove')],
 )
@@ -176,6 +188,8 @@ async def delete_system_role(
 
 @role_controller.get(
     '/{role_id}',
+    summary='获取角色详情接口',
+    description='用于获取指定角色的详细信息',
     response_model=DataResponseModel[RoleModel],
     dependencies=[UserInterfaceAuthDependency('system:role:query')],
 )
@@ -196,6 +210,8 @@ async def query_detail_system_role(
 
 @role_controller.post(
     '/export',
+    summary='导出角色列表接口',
+    description='用于导出当前符合查询条件的角色列表数据',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -226,6 +242,8 @@ async def export_system_role_list(
 
 @role_controller.put(
     '/changeStatus',
+    summary='修改角色状态接口',
+    description='用于修改角色状态',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )
@@ -255,6 +273,8 @@ async def reset_system_role_status(
 
 @role_controller.get(
     '/authUser/allocatedList',
+    summary='获取已分配用户分页列表接口',
+    description='用于获取指定角色已分配的用户分页列表',
     response_model=PageResponseModel[UserInfoModel],
     dependencies=[UserInterfaceAuthDependency('system:role:list')],
 )
@@ -274,6 +294,8 @@ async def get_system_allocated_user_list(
 
 @role_controller.get(
     '/authUser/unallocatedList',
+    summary='获取未分配用户分页列表接口',
+    description='用于获取指定角色未分配的用户分页列表',
     response_model=PageResponseModel[UserInfoModel],
     dependencies=[UserInterfaceAuthDependency('system:role:list')],
 )
@@ -293,6 +315,8 @@ async def get_system_unallocated_user_list(
 
 @role_controller.put(
     '/authUser/selectAll',
+    summary='分配用户给角色接口',
+    description='用于给指定角色分配用户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )
@@ -314,6 +338,8 @@ async def add_system_role_user(
 
 @role_controller.put(
     '/authUser/cancel',
+    summary='取消分配用户给角色接口',
+    description='用于取消指定用户分配给角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )
@@ -331,6 +357,8 @@ async def cancel_system_role_user(
 
 @role_controller.put(
     '/authUser/cancelAll',
+    summary='批量取消分配用户给角色接口',
+    description='用于批量取消用户分配给角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:role:edit')],
 )

ruoyi-fastapi-backend/module_admin/controller/server_controller.py

@@ -13,6 +13,8 @@ server_controller = APIRouter(prefix='/monitor/server', dependencies=[PreAuthDep
 
 @server_controller.get(
     '',
+    summary='获取服务器监控信息接口',
+    description='用于获取当前服务器的监控信息',
     response_model=DataResponseModel[ServerMonitorModel],
     dependencies=[UserInterfaceAuthDependency('monitor:server:list')],
 )

ruoyi-fastapi-backend/module_admin/controller/user_controller.py

@@ -49,6 +49,8 @@ user_controller = APIRouter(prefix='/system/user', dependencies=[PreAuthDependen
 
 @user_controller.get(
     '/deptTree',
+    summary='获取部门树接口',
+    description='用于获取当前登录用户可见的部门树',
     response_model=DataResponseModel[list[DeptTreeModel]],
     dependencies=[UserInterfaceAuthDependency('system:user:list')],
 )
@@ -65,6 +67,8 @@ async def get_system_dept_tree(
 
 @user_controller.get(
     '/list',
+    summary='获取用户分页列表接口',
+    description='用于获取用户分页列表',
     response_model=PageResponseModel[UserRowModel],
     dependencies=[UserInterfaceAuthDependency('system:user:list')],
 )
@@ -85,6 +89,8 @@ async def get_system_user_list(
 
 @user_controller.post(
     '',
+    summary='新增用户接口',
+    description='用于新增用户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:add')],
 )
@@ -116,6 +122,8 @@ async def add_system_user(
 
 @user_controller.put(
     '',
+    summary='编辑用户接口',
+    description='用于编辑用户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:edit')],
 )
@@ -147,6 +155,8 @@ async def edit_system_user(
 
 @user_controller.delete(
     '/{user_ids}',
+    summary='删除用户接口',
+    description='用于删除用户',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:remove')],
 )
@@ -177,6 +187,8 @@ async def delete_system_user(
 
 @user_controller.put(
     '/resetPwd',
+    summary='重置用户密码接口',
+    description='用于重置用户密码',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:resetPwd')],
 )
@@ -207,6 +219,8 @@ async def reset_system_user_pwd(
 
 @user_controller.put(
     '/changeStatus',
+    summary='修改用户状态接口',
+    description='用于修改用户状态',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:edit')],
 )
@@ -236,6 +250,8 @@ async def change_system_user_status(
 
 @user_controller.get(
     '/profile',
+    summary='获取用户个人信息接口',
+    description='用于获取当前登录用户的个人信息',
     response_model=DynamicResponseModel[UserProfileModel],
 )
 async def query_detail_system_user_profile(
@@ -251,11 +267,15 @@ async def query_detail_system_user_profile(
 
 @user_controller.get(
     '/{user_id}',
+    summary='获取用户详情接口',
+    description='用于获取指定用户的详情信息',
     response_model=DynamicResponseModel[UserDetailModel],
     dependencies=[UserInterfaceAuthDependency('system:user:query')],
 )
 @user_controller.get(
     '/',
+    summary='获取用户岗位和角色列表接口',
+    description='用于获取当前登录用户可见的岗位和角色列表',
     response_model=DynamicResponseModel[UserDetailModel],
     dependencies=[UserInterfaceAuthDependency('system:user:query')],
 )
@@ -276,6 +296,8 @@ async def query_detail_system_user(
 
 @user_controller.post(
     '/profile/avatar',
+    summary='修改用户头像接口',
+    description='用于修改当前登录用户的头像',
     response_model=DynamicResponseModel[AvatarModel],
 )
 @Log(title='个人信息', business_type=BusinessType.UPDATE)
@@ -314,6 +336,8 @@ async def change_system_user_profile_avatar(
 
 @user_controller.put(
     '/profile',
+    summary='修改用户个人信息接口',
+    description='用于修改当前登录用户的个人信息',
     response_model=ResponseBaseModel,
 )
 @Log(title='个人信息', business_type=BusinessType.UPDATE)
@@ -341,6 +365,8 @@ async def change_system_user_profile_info(
 
 @user_controller.put(
     '/profile/updatePwd',
+    summary='修改用户密码接口',
+    description='用于修改当前登录用户的密码',
     response_model=ResponseBaseModel,
 )
 @Log(title='个人信息', business_type=BusinessType.UPDATE)
@@ -366,6 +392,8 @@ async def reset_system_user_password(
 
 @user_controller.post(
     '/importData',
+    summary='批量导入用户接口',
+    description='用于批量导入用户数据',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:import')],
 )
@@ -389,6 +417,8 @@ async def batch_import_system_user(
 
 @user_controller.post(
     '/importTemplate',
+    summary='获取用户导入模板接口',
+    description='用于获取用户导入模板excel文件',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -411,6 +441,8 @@ async def export_system_user_template(
 
 @user_controller.post(
     '/export',
+    summary='导出用户列表接口',
+    description='用于导出当前符合查询条件的用户列表数据',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -441,6 +473,8 @@ async def export_system_user_list(
 
 @user_controller.get(
     '/authRole/{user_id}',
+    summary='获取用户已分配角色列表接口',
+    description='用于获取指定用户已分配的角色列表',
     response_model=DynamicResponseModel[UserRoleResponseModel],
     dependencies=[UserInterfaceAuthDependency('system:user:query')],
 )
@@ -460,6 +494,8 @@ async def get_system_allocated_role_list(
 
 @user_controller.put(
     '/authRole',
+    summary='给用户分配角色接口',
+    description='用于给指定用户分配角色',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('system:user:edit')],
 )

ruoyi-fastapi-backend/module_generator/controller/gen_controller.py

@@ -32,6 +32,8 @@ gen_controller = APIRouter(prefix='/tool/gen', dependencies=[PreAuthDependency()
 
 @gen_controller.get(
     '/list',
+    summary='获取代码生成表分页列表接口',
+    description='用于获取代码生成表分页列表',
     response_model=PageResponseModel[GenTableRowModel],
     dependencies=[UserInterfaceAuthDependency('tool:gen:list')],
 )
@@ -49,6 +51,8 @@ async def get_gen_table_list(
 
 @gen_controller.get(
     '/db/list',
+    summary='获取数据库表分页列表接口',
+    description='用于获取数据库表分页列表',
     response_model=PageResponseModel[GenTableDbRowModel],
     dependencies=[UserInterfaceAuthDependency('tool:gen:list')],
 )
@@ -66,6 +70,8 @@ async def get_gen_db_table_list(
 
 @gen_controller.post(
     '/importTable',
+    summary='导入数据库表接口',
+    description='用于导入数据库表',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('tool:gen:import')],
 )
@@ -86,6 +92,8 @@ async def import_gen_table(
 
 @gen_controller.put(
     '',
+    summary='编辑代码生成表接口',
+    description='用于编辑代码生成表',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('tool:gen:edit')],
 )
@@ -108,6 +116,8 @@ async def edit_gen_table(
 
 @gen_controller.delete(
     '/{table_ids}',
+    summary='删除代码生成表接口',
+    description='用于删除代码生成表',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('tool:gen:remove')],
 )
@@ -126,6 +136,8 @@ async def delete_gen_table(
 
 @gen_controller.post(
     '/createTable',
+    summary='创建数据库表接口',
+    description='用于创建数据库表',
     response_model=ResponseBaseModel,
     dependencies=[RoleInterfaceAuthDependency('admin')],
 )
@@ -144,6 +156,8 @@ async def create_table(
 
 @gen_controller.get(
     '/batchGenCode',
+    summary='生成代码文件接口',
+    description='用于生成代码文件',
     response_class=StreamingResponse,
     responses={
         200: {
@@ -170,6 +184,8 @@ async def batch_gen_code(
 
 @gen_controller.get(
     '/genCode/{table_name}',
+    summary='生成代码文件到本地接口',
+    description='用于生成代码文件到本地',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('tool:gen:code')],
 )
@@ -190,6 +206,8 @@ async def gen_code_local(
 
 @gen_controller.get(
     '/{table_id}',
+    summary='获取代码生成表详情接口',
+    description='用于获取指定代码生成表的详细信息',
     response_model=DataResponseModel[GenTableDetailModel],
     dependencies=[UserInterfaceAuthDependency('tool:gen:query')],
 )
@@ -209,6 +227,8 @@ async def query_detail_gen_table(
 
 @gen_controller.get(
     '/preview/{table_id}',
+    summary='预览生成的代码接口',
+    description='用于预览指定代码生成表生成的代码',
     response_model=DataResponseModel[dict[str, str]],
     dependencies=[UserInterfaceAuthDependency('tool:gen:preview')],
 )
@@ -225,6 +245,8 @@ async def preview_code(
 
 @gen_controller.get(
     '/synchDb/{table_name}',
+    summary='同步数据库接口',
+    description='用于同步指定数据库信息到指定代码生成表',
     response_model=DataResponseModel[str],
     dependencies=[UserInterfaceAuthDependency('tool:gen:edit')],
 )

ruoyi-fastapi-backend/module_generator/templates/python/controller.py.jinja2

@@ -37,6 +37,8 @@ from utils.response_util import ResponseUtil
 
 @{{ businessName }}_controller.get(
     '/list',
+    summary='获取{{ functionName }}分页列表接口',
+    description='用于获取{{ functionName }}分页列表',
     response_model=PageResponseModel[{{ BusinessName }}Model],
     dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:list')],
 )
@@ -61,6 +63,8 @@ async def get_{{ moduleName }}_{{ businessName }}_list(
 
 @{{ businessName }}_controller.post(
     '',
+    summary='新增{{ functionName }}接口',
+    description='用于新增{{ functionName }}',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:add')],
 )
@@ -91,6 +95,8 @@ async def add_{{ moduleName }}_{{ businessName }}(
 
 @{{ businessName }}_controller.put(
     '',
+    summary='编辑{{ functionName }}接口',
+    description='用于编辑{{ functionName }}',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:edit')],
 )
@@ -117,6 +123,8 @@ async def edit_{{ moduleName }}_{{ businessName }}(
 
 @{{ businessName }}_controller.delete(
     '/{% raw %}{{% endraw %}{{ pk_field }}s{% raw %}}{% endraw %}',
+    summary='删除{{ functionName }}接口',
+    description='用于删除{{ functionName }}',
     response_model=ResponseBaseModel,
     dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:remove')],
 )
@@ -135,6 +143,8 @@ async def delete_{{ moduleName }}_{{ businessName }}(
 
 @{{ businessName }}_controller.get(
     '/{% raw %}{{% endraw %}{{ pk_field }}{% raw %}}{% endraw %}',
+    summary='获取{{ functionName }}详情接口',
+    description='用于获取指定{{ functionName }}的详细信息',
     response_model=DataResponseModel[{{ BusinessName }}Model],
     dependencies=[UserInterfaceAuthDependency('{{ permissionPrefix }}:query')]
 )
@@ -151,6 +161,8 @@ async def query_detail_{{ moduleName }}_{{ businessName }}(
 
 @{{ businessName }}_controller.post(
     '/export',
+    summary='导出{{ functionName }}列表接口',
+    description='用于导出当前符合查询条件的{{ functionName }}列表数据',
     response_class=StreamingResponse,
     responses={
         200: {