mirror of
https://github.com/fastapiadmin/FastapiAdmin.git
synced 2026-09-20 20:39:55 +00:00
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): 完善工具函数的文档字符串
56 lines
2.1 KiB
Python
56 lines
2.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
from typing import List, Optional
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
from app.core.validator import DateTimeStr
|
|
|
|
|
|
class UserInfoSchema(BaseModel):
|
|
"""用户信息模型"""
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
id: int = Field(description="用户ID")
|
|
name: str = Field(description="用户姓名")
|
|
username: str = Field(description="用户名")
|
|
|
|
class CommonSchema(BaseModel):
|
|
"""用户信息模型"""
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
id: int = Field(description="编号ID")
|
|
name: str = Field(description="名称")
|
|
|
|
|
|
class BaseSchema(BaseModel):
|
|
"""通用输出模型,包含基础字段和审计字段"""
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
id: Optional[int] = Field(default=None, description="主键ID")
|
|
description: Optional[str] = Field(default=None, description="描述")
|
|
created_at: Optional[DateTimeStr] = Field(default=None, description="创建时间")
|
|
updated_at: Optional[DateTimeStr] = Field(default=None, description="更新时间")
|
|
creator_id: Optional[int] = Field(default=None, description="创建人ID")
|
|
creator: Optional[UserInfoSchema] = Field(default=None, description="创建人信息")
|
|
|
|
|
|
class BatchSetAvailable(BaseModel):
|
|
"""批量设置可用状态的请求模型"""
|
|
ids: List[int] = Field(default_factory=list, description="ID列表")
|
|
status: bool = Field(default=True, description="是否可用")
|
|
|
|
|
|
class UploadResponseSchema(BaseModel):
|
|
"""上传响应模型"""
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
file_path: Optional[str] = Field(default=None, description='新文件映射路径')
|
|
file_name: Optional[str] = Field(default=None, description='新文件名称')
|
|
origin_name: Optional[str] = Field(default=None, description='原文件名称')
|
|
file_url: Optional[str] = Field(default=None, description='新文件访问地址')
|
|
|
|
class DownloadFileSchema(BaseModel):
|
|
"""下载文件模型"""
|
|
file_path: str = Field(..., description='新文件映射路径')
|
|
file_name: str = Field(..., description='新文件名称')
|