fix: dtos示例文件增加说明

src/dtos/example.py

@@ -1,26 +1,25 @@
-from typing import List
+from typing import List, Optional
 
 from pydantic import Field
 
 from src.dtos import BaseModel, BaseResponse, ListResponse, PageItemModel
 
 
-class UserDto(BaseModel):
+class UserExampleDto(BaseModel):
-    id: int = Field(None, alias='id', description='id')
+    """用户示例类"""
-    userName: str = Field(None, description='用户名')
+    id: int  # 表示字段必需
+    # Field 第一个参数：...代表字段必需 None代表字段可选，alias：表示返回最终的字段名，description: 文档描述
+    userName: str = Field(..., alias="user_name", description='用户名')
+    email: str = Field(None, description="用户email")
+    age: Optional[int]  # Optional 代表字段可选
 
-    class Config:
+class UserExampleListPagesItem(PageItemModel):
-        orm_mode = True
+    items: List[UserExampleDto]
-        allow_population_by_field_name = True
 
 
-class UserListPagesItem(PageItemModel):
+class UserExampleListPagesResult(ListResponse):
-    items: List[UserDto]
+    result: UserExampleListPagesItem
 
 
-class UserListPagesResult(ListResponse):
+class UserExampleListResult(BaseResponse):
-    result: UserListPagesItem
+    result: List[UserExampleDto]
-
-
-class UserListResult(BaseResponse):
-    result: List[UserDto]