update docs

Author: wu-clan

docs/.vuepress/sidebar.ts

@@ -29,10 +29,10 @@ export const mySidebar: ThemeSidebarMulti = {
             collapsed: false,
             prefix: 'reference/',
             items: [
+                { text: '模型', link: 'model' },
+                { text: 'Schema', link: 'schema' },
                 { text: '路由', link: 'router' },
                 { text: 'CRUD', link: 'CRUD' },
-                { text: 'Schema', link: 'schema' },
-                { text: '操作人信息', link: '/planet', icon: 'fluent-color:receipt-16' },
                 { text: '分页', link: 'pagination' },
                 { text: '接口响应', link: 'response' },
                 { text: '自定义异常', link: '/planet', icon: 'fluent-color:receipt-16' },

docs/backend/reference/CRUD.md

@@ -20,56 +20,3 @@ fba 遵循以下命名规范：
 - 创建：`create()`
 - 更新：`update()`
 - 删除：`delete()`
-
-## Mixin
-
-CRUD Mixin 位于 `backend/common/model.py` 文件中
-
-### 主键
-
-我们未提供自动主键模式，而是必须通过手动定义的方式进行主键声明
-
-```python
-# 通用 Mapped 类型主键, 需手动添加，参考以下使用方式
-# MappedBase -> id: Mapped[id_key]
-# DataClassBase && Base -> id: Mapped[id_key] = mapped_column(init=False)
-id_key = Annotated[
-    int, mapped_column(primary_key=True, index=True, autoincrement=True, sort_order=-999, comment='主键id')
-]
-```
-
-### 日期时间
-
-日期时间 Mixin 将自动集成到 Base 类中，如果模型父类为 Base，将自动应用
-
-```python
-class DateTimeMixin(MappedAsDataclass):
-    """日期时间 Mixin 数据类"""
-
-    created_time: Mapped[datetime] = mapped_column(
-        DateTime(timezone=True), init=False, default_factory=timezone.now, sort_order=999, comment='创建时间'
-    )
-    updated_time: Mapped[datetime | None] = mapped_column(
-        DateTime(timezone=True), init=False, onupdate=timezone.now, sort_order=999, comment='更新时间'
-    )
-```
-
-### 数据类基类
-
-[MappedAsDataclass](https://docs.sqlalchemy.org/en/20/orm/dataclasses.html#orm-declarative-native-dataclasses)
-
-声明性数据类基类, 它将带有数据类集成, 允许使用更高级配置；此基类适用于==不包含日期时间的模型=={.note}
-
-```python
-class DataClassBase(MappedAsDataclass, MappedBase):
-    __abstract__ = True
-```
-
-### Base 基类
-
-包含基础表结构的数据类基类；此基类适用于大多数模型
-
-```python
-class Base(DataClassBase, DateTimeMixin):
-    __abstract__ = True
-```

docs/backend/reference/model.md

@@ -0,0 +1,72 @@
+---
+title: 模型
+---
+
+通用模型位于 `backend/common/model.py` 文件中
+
+## 主键
+
+我们未提供自动主键模式，而是必须通过手动定义的方式进行主键声明
+
+```python
+# 通用 Mapped 类型主键, 需手动添加，参考以下使用方式
+# MappedBase -> id: Mapped[id_key]
+# DataClassBase && Base -> id: Mapped[id_key] = mapped_column(init=False)
+id_key = Annotated[
+    int, mapped_column(primary_key=True, index=True, autoincrement=True, sort_order=-999, comment='主键id')
+]
+```
+
+## Mixin 类
+
+[Mixin](https://en.wikipedia.org/wiki/Mixin) 是一种面向对象编程概念, 使结构变得更加清晰
+
+### 操作人
+
+用于集成操作人信息到数据库表，使用方法请查看：[<Icon name="fluent-color:receipt-16" />操作人信息](../../planet.md)
+
+```python
+class UserMixin(MappedAsDataclass):
+    """用户 Mixin 数据类"""
+
+    created_by: Mapped[int] = mapped_column(sort_order=998, comment='创建者')
+    updated_by: Mapped[int | None] = mapped_column(init=False, default=None, sort_order=998, comment='修改者')
+```
+
+### 日期时间
+
+用于集成日期时间到数据库表，已集成在 [Base](#base-基类) 基类中
+
+```python
+class DateTimeMixin(MappedAsDataclass):
+    """日期时间 Mixin 数据类"""
+
+    created_time: Mapped[datetime] = mapped_column(
+        DateTime(timezone=True), init=False, default_factory=timezone.now, sort_order=999, comment='创建时间'
+    )
+    updated_time: Mapped[datetime | None] = mapped_column(
+        DateTime(timezone=True), init=False, onupdate=timezone.now, sort_order=999, comment='更新时间'
+    )
+```
+
+## 数据类基类
+
+[MappedAsDataclass](https://docs.sqlalchemy.org/en/20/orm/dataclasses.html#orm-declarative-native-dataclasses)
+
+声明性数据类基类，它将带有数据类集成，允许使用更高级配置，==不包含日期时间=={.note}
+
+```python
+class DataClassBase(MappedAsDataclass, MappedBase):
+
+    __abstract__ = True
+```
+
+## Base 基类
+
+声明性数据类基类, 带有数据类集成, 并包含日期时间
+
+```python
+class Base(DataClassBase, DateTimeMixin):
+
+    __abstract__ = True
+```

package.json

@@ -14,15 +14,15 @@
   "license": "MIT",
   "devDependencies": {
     "@vuepress/bundler-vite": "2.0.0-rc.20",
-    "@vuepress/plugin-baidu-analytics": "2.0.0-rc.86",
+    "@vuepress/plugin-baidu-analytics": "2.0.0-rc.91",
     "@vuepress/plugin-google-analytics": "2.0.0-rc.80",
-    "@vuepress/plugin-umami-analytics": "2.0.0-rc.86",
+    "@vuepress/plugin-umami-analytics": "2.0.0-rc.91",
     "vue": "^3.5.13",
     "vuepress": "2.0.0-rc.20",
-    "vuepress-theme-plume": "1.0.0-rc.137"
+    "vuepress-theme-plume": "1.0.0-rc.138"
   },
   "dependencies": {
-    "@iconify/json": "^2.2.321",
+    "@iconify/json": "^2.2.323",
     "@vueuse/core": "^12.8.2",
     "mermaid": "^11.6.0",
     "swiper": "^11.2.6"