From fffff50a006fe30418ff12201000dee3a0a226c6 Mon Sep 17 00:00:00 2001
From: insistence <3055204202@qq.com>
Date: Fri, 5 Jul 2024 11:07:33 +0800
Subject: [PATCH] =?UTF-8?q?perf:=20=E7=99=BB=E5=BD=95=E6=A8=A1=E5=9D=97vo?=
 =?UTF-8?q?=E5=B1=82=E4=BC=98=E5=8C=96?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../module_admin/entity/vo/login_vo.py        | 72 +++++++++----------
 1 file changed, 36 insertions(+), 36 deletions(-)

diff --git a/ruoyi-fastapi-backend/module_admin/entity/vo/login_vo.py b/ruoyi-fastapi-backend/module_admin/entity/vo/login_vo.py
index 76bb7b8..c3ee684 100644
--- a/ruoyi-fastapi-backend/module_admin/entity/vo/login_vo.py
+++ b/ruoyi-fastapi-backend/module_admin/entity/vo/login_vo.py
@@ -1,5 +1,5 @@
 import re
-from pydantic import BaseModel, ConfigDict, model_validator
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 from pydantic.alias_generators import to_camel
 from typing import Optional, List, Union
 from exceptions.exception import ModelValidatorException
@@ -9,22 +9,22 @@ from module_admin.entity.vo.menu_vo import MenuModel
 class UserLogin(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel)
 
-    user_name: str
-    password: str
-    code: Optional[str] = None
-    uuid: Optional[str] = None
-    login_info: Optional[dict] = None
-    captcha_enabled: Optional[bool] = None
+    user_name: str = Field(description='用户名称')
+    password: str = Field(description='用户密码')
+    code: Optional[str] = Field(default=None, description='验证码')
+    uuid: Optional[str] = Field(default=None, description='会话编号')
+    login_info: Optional[dict] = Field(default=None, description='登录信息，前端无需传递')
+    captcha_enabled: Optional[bool] = Field(default=None, description='是否启用验证码，前端无需传递')
 
 
 class UserRegister(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel)
 
-    username: str
-    password: str
-    confirm_password: str
-    code: Optional[str] = None
-    uuid: Optional[str] = None
+    username: str = Field(description='用户名称')
+    password: str = Field(description='用户密码')
+    confirm_password: str = Field(description='用户二次确认密码')
+    code: Optional[str] = Field(default=None, description='验证码')
+    uuid: Optional[str] = Field(default=None, description='会话编号')
 
     @model_validator(mode='after')
     def check_password(self) -> 'UserRegister':
@@ -36,48 +36,48 @@ class UserRegister(BaseModel):
 
 
 class Token(BaseModel):
-    access_token: str
-    token_type: str
+    access_token: str = Field(description='token信息')
+    token_type: str = Field(description='token类型')
 
 
 class CaptchaCode(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel)
 
-    captcha_enabled: bool
-    register_enabled: bool
-    img: str
-    uuid: str
+    captcha_enabled: bool = Field(description='是否启用验证码')
+    register_enabled: bool = Field(description='是否启用注册')
+    img: str = Field(description='验证码图片')
+    uuid: str = Field(description='会话编号')
 
 
 class SmsCode(BaseModel):
-    is_success: Optional[bool] = None
-    sms_code: str
-    session_id: str
-    message: Optional[str] = None
+    is_success: Optional[bool] = Field(default=None, description='操作是否成功')
+    sms_code: str = Field(description='短信验证码')
+    session_id: str = Field(description='会话编号')
+    message: Optional[str] = Field(default=None, description='响应信息')
 
 
 class MenuTreeModel(MenuModel):
-    children: Optional[Union[List['MenuTreeModel'], None]] = None
+    children: Optional[Union[List['MenuTreeModel'], None]] = Field(default=None, description='子菜单')
 
 
 class MetaModel(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel)
 
-    title: Optional[str] = None
-    icon: Optional[str] = None
-    no_cache: Optional[bool] = None
-    link: Optional[str] = None
+    title: Optional[str] = Field(default=None, description='设置路由在侧边栏和面包屑中展示的名字')
+    icon: Optional[str] = Field(default=None, description='设置路由的图标')
+    no_cache: Optional[bool] = Field(default=None, description='设置为true，则不会被 <keep-alive>缓存')
+    link: Optional[str] = Field(default=None, description='内链地址（http(s)://开头）')
 
 
 class RouterModel(BaseModel):
     model_config = ConfigDict(alias_generator=to_camel)
 
-    name: Optional[str] = None
-    path: Optional[str] = None
-    hidden: Optional[bool] = None
-    redirect: Optional[str] = None
-    component: Optional[str] = None
-    query: Optional[str] = None
-    always_show: Optional[bool] = None
-    meta: Optional[MetaModel] = None
-    children: Optional[Union[List['RouterModel'], None]] = None
+    name: Optional[str] = Field(default=None, description='路由名称')
+    path: Optional[str] = Field(default=None, description='路由地址')
+    hidden: Optional[bool] = Field(default=None, description='是否隐藏路由，当设置 true 的时候该路由不会再侧边栏出现')
+    redirect: Optional[str] = Field(default=None, description='重定向地址，当设置 noRedirect 的时候该路由在面包屑导航中不可被点击')
+    component: Optional[str] = Field(default=None, description='组件地址')
+    query: Optional[str] = Field(default=None, description='路由参数：如 {"id": 1, "name": "ry"}')
+    always_show: Optional[bool] = Field(default=None, description='当你一个路由下面的children声明的路由大于1个时，自动会变成嵌套的模式--如组件页面')
+    meta: Optional[MetaModel] = Field(default=None, description='其他元素')
+    children: Optional[Union[List['RouterModel'], None]] = Field(default=None, description='子路由')