mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-21 12:52:26 +00:00
zhangtao
c2ca6d19ac
style: 统一代码风格和格式 docs: 完善函数和方法的文档字符串 refactor(base_model): 移除冗余的表名和表参数生成方法 refactor(constant): 更新返回码注释格式 refactor(router_class): 添加路由处理器的详细文档 refactor(database): 完善数据库连接函数的文档 refactor(security): 添加认证类和方法的详细文档 refactor(validator): 更新验证器函数的文档格式 refactor(serialize): 优化序列化工具类的文档 refactor(response): 完善响应类的文档字符串 refactor(dependencies): 添加依赖函数的详细文档 refactor(initialize): 完善初始化脚本的文档 refactor(plugin): 添加生命周期和中间件注册的文档 refactor(service): 完善服务层方法的文档 refactor(controller): 添加控制器方法的详细文档 refactor(crud): 完善CRUD操作的文档字符串 refactor(schema): 简化模型类并移除冗余字段 refactor(param): 更新查询参数类的注释格式 refactor(template): 优化代码生成模板的格式 refactor(console): 添加控制台输出功能的实现 refactor(util): 完善工具函数的文档字符串
101 lines
3.3 KiB
Python
101 lines
3.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from fastapi import APIRouter, Body, Depends
|
|
from fastapi.responses import JSONResponse
|
|
from redis.asyncio.client import Redis
|
|
|
|
from app.common.request import PaginationService
|
|
from app.common.response import SuccessResponse,ErrorResponse
|
|
from app.core.dependencies import AuthPermission, redis_getter
|
|
from app.core.base_params import PaginationQueryParam
|
|
from app.core.router_class import OperationLogRoute
|
|
from app.core.logger import logger
|
|
from .param import OnlineQueryParam
|
|
from .service import OnlineService
|
|
|
|
|
|
OnlineRouter = APIRouter(route_class=OperationLogRoute, prefix="/online", tags=["在线用户"])
|
|
|
|
|
|
@OnlineRouter.get(
|
|
'/list',
|
|
dependencies=[Depends(AuthPermission(['monitor:online:query']))],
|
|
summary="获取在线用户列表",
|
|
description="获取在线用户列表"
|
|
)
|
|
async def get_online_list_controller(
|
|
redis: Redis = Depends(redis_getter),
|
|
paging_query: PaginationQueryParam = Depends(),
|
|
search: OnlineQueryParam = Depends()
|
|
)->JSONResponse:
|
|
"""
|
|
获取在线用户列表
|
|
|
|
参数:
|
|
- redis (Redis): Redis异步客户端实例。
|
|
- paging_query (PaginationQueryParam): 分页查询参数模型。
|
|
- search (OnlineQueryParam): 查询参数模型。
|
|
|
|
返回:
|
|
- JSONResponse: 包含在线用户列表的JSON响应。
|
|
"""
|
|
result_dict_list = await OnlineService.get_online_list_service(redis=redis, search=search)
|
|
result_dict = await PaginationService.paginate(data_list= result_dict_list, page_no= paging_query.page_no, page_size = paging_query.page_size)
|
|
logger.info('获取成功')
|
|
|
|
return SuccessResponse(data=result_dict,msg='获取成功')
|
|
|
|
|
|
@OnlineRouter.delete(
|
|
'/delete',
|
|
dependencies=[Depends(AuthPermission(['monitor:online:delete']))],
|
|
summary="强制下线",
|
|
description="强制下线"
|
|
)
|
|
async def delete_online_controller(
|
|
session_id: str = Body(..., description="会话编号"),
|
|
redis: Redis = Depends(redis_getter),
|
|
)->JSONResponse:
|
|
"""
|
|
强制下线指定在线用户
|
|
|
|
参数:
|
|
- session_id (str): 在线用户会话ID。
|
|
- redis (Redis): Redis异步客户端实例。
|
|
|
|
返回:
|
|
- JSONResponse: 包含操作结果的JSON响应。
|
|
"""
|
|
is_ok = await OnlineService.delete_online_service(redis=redis, session_id=session_id)
|
|
if is_ok:
|
|
logger.info("强制下线成功")
|
|
return SuccessResponse(msg="强制下线成功")
|
|
else:
|
|
logger.info("强制下线失败")
|
|
return ErrorResponse(msg="强制下线失败")
|
|
|
|
@OnlineRouter.delete(
|
|
'/clear',
|
|
dependencies=[Depends(AuthPermission(['monitor:online:delete']))],
|
|
summary="清除所有在线用户",
|
|
description="清除所有在线用户"
|
|
)
|
|
async def clear_online_controller(
|
|
redis: Redis = Depends(redis_getter),
|
|
)->JSONResponse:
|
|
"""
|
|
清除所有在线用户
|
|
|
|
参数:
|
|
- redis (Redis): Redis异步客户端实例。
|
|
|
|
返回:
|
|
- JSONResponse: 包含操作结果的JSON响应。
|
|
"""
|
|
is_ok = await OnlineService.clear_online_service(redis=redis)
|
|
if is_ok:
|
|
logger.info("清除所有在线用户成功")
|
|
return SuccessResponse(msg="清除所有在线用户成功")
|
|
else:
|
|
logger.info("清除所有在线用户失败")
|
|
return ErrorResponse(msg="清除所有在线用户失败") |