Files
FastapiAdmin/backend/app/api/v1/module_platform/plugin/schema.py
T
zhangtao 414d5c80c3 refactor: 统一项目中状态字段类型为数字类型
这是一个大规模的类型对齐优化:
1.  将多处字符串类型的status字段统一改为数字类型,包括前后端接口定义、数据模型、页面组件
2.  重构编排节点相关的命名和注释,统一改为"节点类型"替代"编排节点类型"
3.  移除了过时的忘记密码相关接口和模板代码
4.  优化搜索栏组件,支持展开仅显示次要字段
5.  调整部分接口参数和路由逻辑,对齐前后端参数格式
2026-06-23 00:30:40 +08:00

100 lines
3.8 KiB
Python
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
from dataclasses import dataclass
from fastapi import Query
from pydantic import BaseModel, ConfigDict, Field, field_validator
from app.common.enums import QueueEnum
from app.core.base_params import BaseQueryParam
from app.core.base_schema import BaseSchema
class PluginCreateSchema(BaseModel):
"""新增插件"""
name: str = Field(..., min_length=1, max_length=100, description="插件名称")
code: str = Field(..., min_length=1, max_length=50, description="插件编码(如 module_xxx")
version: str = Field(default="1.0.0", max_length=20, description="版本号")
author: str | None = Field(default=None, max_length=100, description="作者")
icon: str | None = Field(default=None, max_length=500, description="图标URL")
category: str = Field(default="tool", max_length=20, description="分类(tool/ai/monitor/business)")
price: int = Field(default=0, ge=0, description="价格(分,0=免费)")
menu_path: str | None = Field(default=None, max_length=200, description="菜单路径")
permission_prefix: str | None = Field(default=None, max_length=100, description="权限前缀")
dependencies: str | None = Field(default=None, description="依赖插件编码(JSON数组)")
sort: int = Field(default=0, ge=0, description="排序")
status: int = Field(default=0, ge=0, le=1, description="状态(0:启动 1:停用)")
description: str | None = Field(default=None, max_length=255, description="插件描述")
@field_validator("category")
@classmethod
def _validate_category(cls, v: str) -> str:
allowed = {"tool", "ai", "monitor", "business"}
if v not in allowed:
raise ValueError(f"插件分类仅支持 tool、ai、monitor、business,当前值: {v}")
return v
@field_validator("version")
@classmethod
def _validate_version(cls, v: str) -> str:
import re
if not re.match(r"^\d+\.\d+\.\d+$", v):
raise ValueError("版本号格式需为 x.y.z(如 1.0.0")
return v
@field_validator("code")
@classmethod
def _validate_code(cls, v: str) -> str:
v = v.strip()
if not v:
raise ValueError("插件编码不能为空")
return v
class PluginUpdateSchema(PluginCreateSchema):
"""更新插件 — 所有字段可选"""
name: str | None = Field(default=None, max_length=100, description="插件名称") # type: ignore[assignment]
code: str | None = Field(default=None, max_length=50, description="插件编码") # type: ignore[assignment]
status: int | None = Field(default=None, ge=0, le=1, description="状态(0:启动 1:停用)")
@field_validator("status")
@classmethod
def _validate_status(cls, v: int | None) -> int | None:
if v is None:
return v
if v not in {0, 1}:
raise ValueError("状态仅支持 0(正常) 或 1(禁用)")
return v
class PluginOutSchema(PluginCreateSchema, BaseSchema):
"""插件响应"""
model_config = ConfigDict(from_attributes=True)
installed: bool = False # 当前租户是否已安装
class PluginInstallSchema(BaseModel):
"""安装/卸载插件"""
plugin_id: int = Field(..., description="插件ID")
@dataclass
class PluginQueryParam(BaseQueryParam):
"""插件查询参数"""
name: str | None = Query(None, description="插件名称")
category: str | None = Query(None, description="插件分类(tool/ai/monitor/business)")
status: int | None = Query(None, ge=0, le=1, description="状态(0:启动 1:停用)")
def __post_init__(self) -> None:
if self.name:
self.name = (QueueEnum.like.value, self.name)
if self.category:
self.category = (QueueEnum.eq.value, self.category)
if isinstance(self.status, int):
self.status = (QueueEnum.eq.value, self.status)