update docs

Author: wu-clan

docs/README.md

@@ -13,6 +13,9 @@ config:
         - theme: brand
           text: 快速开始 ->
           link: /guide/summary/quick-start
+        - theme: alt
+          text: 伪三层架构?
+          link: /guide/summary/intro#伪三层架构
         - theme: alt
           text: 为什么选择我们?
           link: /guide/summary/why

docs/guide/reference/schema.md

@@ -17,9 +17,8 @@ title: schema
 
 ## Field
 
-fba 内部暂未大量使用 Field，它后期可能被添加，但最也仅仅是将其用于添加描述，这很有助于接口文档字段说明，但也有可能因此
-PR 改变计划
-：[Allow to have multiple Query parameter models](https://github.com/fastapi/fastapi/pull/12944#pullrequestreview-2588580175)
+- 不建议将必填字段默认值设置为 `...`，参考：[必填字段](https://docs.pydantic.dev/latest/concepts/models/#required-fields)
+- 建议为所有字段至少添加 `description`，这对于 API 文档来说非常有用
 
 ## 驼峰返回
 

docs/guide/summary/intro.md

@@ -13,77 +13,79 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 如果您不喜欢这种模式，可以使用模板对其进行任意改造！
 
 | 工作流程 | java           | fastapi_best_architecture |
-|------|----------------|---------------------------|
-| 视图   | controller     | api                       |
+| -------- | -------------- | ------------------------- |
+| 视图     | controller     | api                       |
 | 数据传输 | dto            | schema                    |
 | 业务逻辑 | service + impl | service                   |
 | 数据访问 | dao / mapper   | crud                      |
-| 模型   | model / entity | model                     |
+| 模型     | model / entity | model                     |
 
-## 特征
+## 特性
 
 - [x] 全局 FastAPI PEP 593 Annotated 参数风格
-- [x] async/await + asgiref 的全局异步设计
-- [x] 遵循 Restful API 规范
-- [x] 全局 SQLAlchemy 2.0 语法
-- [x] Pydantic v1 和 v2 (不同分支)
-- [x] Casbin RBAC 访问控制模型
-- [x] 角色菜单 RBAC 访问控制模型
-- [x] Celery 异步任务
-- [x] JWT 中间件白名单认证
-- [x] 全局自定义时区时间
-- [x] Docker / Docker-compose 部署
-- [x] Pytest 单元测试
+- [x] 全面 async/await + asgiref 异步设计
+- [x] 遵循 RESTful API 规范
+- [x] 使用 SQLAlchemy 2.0 全新语法
+- [x] 使用 Pydantic v2 版本
+- [x] 实现角色菜单 RBAC 访问控制
+- [x] 集成 Casbin RBAC 访问控制
+- [x] 支持 Celery 异步任务
+- [x] 自研 JWT 认证中间件
+- [x] 支持全局自定义时间时区
+- [x] 支持 Docker / Docker-compose 部署
+- [x] 集成 Pytest 单元测试
 
 ## 内置功能
 
-- [x] 用户管理：系统用户角色管理，权限分配
-- [x] 部门管理：配置系统组织机构（公司、部门、小组...）
-- [x] 菜单管理：配置系统菜单，用户菜单，按钮权限标识
-- [x] 角色管理：角色菜单权限分配，角色路由权限分配
-- [x] 字典管理：维护系统内部常用固定数据或参数
-- [x] 令牌管理：系统用户在线状态检测，支持踢人下线
-- [x] 登录认证：基于后端的图形验证码后台认证登录
-- [x] 多点登录：通过用户信息一键修改多点登录支持
-- [x] OAuth20：内置自研 OAuth 2.0 登录集成
-- [x] 代码生成：后端代码自动生成，支持预览，写入及下载
-- [x] 定时任务：自动化任务，异步任务，支持函数调用
-- [x] 插件系统：通过热插拔插件模式告别高耦合集成
-- [x] 操作日志：系统正常和异常操作的日志记录与查询
-- [x] 登录日志：用户正常和异常登录的日志记录与查询
-- [x] 服务监控：服务器硬件设备信息与状态
+- [x] 用户管理：分配角色和权限
+- [x] 部门管理：配置组织架构（公司、部门、小组等）
+- [x] 菜单管理：设置菜单及按钮级权限
+- [x] 角色管理：配置角色、分配菜单和权限
+- [x] 字典管理：维护常用参数和配置
+- [x] 参数管理：系统常用参数动态配置
+- [x] 通知公告：发布和维护系统通知公告信息
+- [x] 令牌管理：检测在线状态，支持强制下线
+- [x] 多端登录：支持一键切换多端登录模式
+- [x] OAuth 2.0：内置自研 OAuth 2.0 授权登录
+- [x] 插件系统：热插拔插件设计，降低耦合
+- [x] 定时任务：支持定时，异步任务及函数调用
+- [x] 代码生成：自动生成代码，支持预览、写入和下载
+- [x] 操作日志：记录和查询正常和异常操作
+- [x] 登录日志：记录和查询正常和异常登录
+- [x] 缓存监控：查询系统缓存信息和命令统计
+- [x] 服务监控：查看服务器硬件信息和状态
 - [x] 接口文档：自动生成在线交互式 API 文档
 
 ## 项目结构
 
 ::: file-tree
 
 - backend 后端
-    - alembic/ 数据库迁移
-    - app 应用
-        - admin/ 系统后台
-            - api/ 接口
-            - crud/ CRUD
-            - model 模型
-                - \_\_init__.py 必须在此文件内导入所有模型类
-                - …
-            - schema/ 数据传输
-            - service/ 服务
-            - tests/ 单元测试
-        - generator/ 代码生成
-        - task/ 任务
+  - alembic/ 数据库迁移
+  - app 应用
+    - admin/ 系统后台
+      - api/ 接口
+      - crud/ CRUD
+      - model 模型
+        - \_\_init\_\_.py 必须在此文件内导入所有模型类
         - …
-    - common/ 公共资源
-    - core/ 核心配置
-    - database/ 数据库连接
-    - log/ 日志
-    - middleware/ 中间件
-    - plugin/ 插件
-    - scripts/ 脚本
-    - sql/ SQL文件
-    - static/ 静态文件
-    - templates/ 模版文件
-    - utils/ 工具包
+      - schema/ 数据传输
+      - service/ 服务
+      - tests/ 单元测试
+    - generator/ 代码生成
+    - task/ 任务
+    - …
+  - common/ 公共资源
+  - core/ 核心配置
+  - database/ 数据库连接
+  - log/ 日志
+  - middleware/ 中间件
+  - plugin/ 插件
+  - scripts/ 脚本
+  - sql/ SQL 文件
+  - static/ 静态文件
+  - templates/ 模版文件
+  - utils/ 工具包
 - deploy/ 服务器部署
 - …
 

docs/guide/summary/quick-start.md

@@ -260,13 +260,13 @@ title: 快速开始
 
 1. 定义数据库模型（model）
 
-2. 定义数据验证模型（schema）
+2. 定义数据验证模型（[schema](../reference/schema.md)）
 
-3. 定义视图（api）和路由（router）
+3. 定义路由（[router](../reference/router.md)）
 
 4. 编写业务（service）
 
-5. 编写数据库操作（crud）
+5. 编写数据库操作（[crud](../reference/CRUD.md)）
 
 :::