update docs

wu-clan · wu-clan · commit 5b2d838c2401 · 2025-01-10T15:10:58.000+08:00
diff --git a/docs/README.md b/docs/README.md
@@ -7,7 +7,7 @@ config:
     background: tint-plate
     hero:
       name: FastAPI Best Architecture
-      tagline: 企业级中后台解决方案
+      tagline: 企业级后端架构解决方案
       text: 基于 FastAPI 框架，前后端分离，遵循「伪三层架构」设计，支持 Python 3.10+ 版本
       actions:
         - theme: brand
diff --git a/docs/guide/reference/CORS.md b/docs/guide/reference/CORS.md
@@ -15,20 +15,28 @@ CORS_ALLOWED_ORIGINS: list[str] = [
 
 ## 服务器
 
-1. 非 https 部署
-
-    ```py
-    # [!code word:http]
-    CORS_ALLOWED_ORIGINS: list[str] = [
-            'http://服务器ip:端口号',  # 前端访问地址，末尾不要带 '/'
-        ]
-    ```
-
-2. https 部署
-
-    ```py
-    # [!code word:https]
-    CORS_ALLOWED_ORIGINS: list[str] = [
-            'https://域名',  # 前端访问地址，末尾不要带 '/'
-        ]
-    ```
+HTTP 部署
+
+```py
+# [!code word:http]
+CORS_ALLOWED_ORIGINS: list[str] = [
+      'http://服务器ip:端口号',  # 前端访问地址，末尾不要带 '/'
+  ]
+```
+
+HTTPS 部署
+
+```py
+# [!code word:https]
+CORS_ALLOWED_ORIGINS: list[str] = [
+      'https://域名',  # 前端访问地址，末尾不要带 '/'
+  ]
+```
+
+## 局域网
+
+此方式取决于前端项目是否配置局域网服务
+
+```py
+CORS_ALLOWED_ORIGINS: list[str] = ['*']
+```
diff --git a/docs/guide/reference/jwt.md b/docs/guide/reference/jwt.md
@@ -2,14 +2,10 @@
 title: JWT
 ---
 
-::: tip
-通过 JWT 中间件实现全局自动授权
-:::
-
 我们编写了自定义的 JWT 授权中间件，使其可以在每次请求发起时，自动调用此中间件实现自动授权，并且，通过 Redis 和 Rust
-库对用户信息进行快速缓存，使其性能影响尽可能降到最低
+库对用户信息进行缓存和解析，使其性能影响尽可能降到最低
 
-```python
+```python :collapsed-lines=10
 class JwtAuthMiddleware(AuthenticationBackend):
     """JWT 认证中间件"""
 
@@ -47,11 +43,17 @@ class JwtAuthMiddleware(AuthenticationBackend):
         return AuthCredentials(['authenticated']), user
 ```
 
-## 验证码登录
+## Token
+
+内置遵循 [rfc6750](https://datatracker.ietf.org/doc/html/rfc6750) 标准实现的 HTTP 授权方式，如果您想使用自定义 header
+添加 token 进行授权，可以查看我们的 [非公开内容](../../planet.md#fastapi)
+
+### 验证码登录
 
-您可以通过验证码登录进行授权，在大多数情况下，这更适用于前端登录验证
+您可以通过验证码登录获取 token，在大多数情况下，这更适用于配合前端实现登录授权
 
-我们在 FBA 中使用 [fast_captcha](https://github.com/wu-clan/fast-captcha) 生成 base64 验证码，通过接口进行数据返回，您可以通过在线 base64 转图片或配合前端项目将其转为图片进行预览
+我们在 FBA 中使用 [fast_captcha](https://github.com/wu-clan/fast-captcha) 生成 base64 验证码，通过接口进行数据返回；您可以通过在线
+base64 转图片或配合前端项目将其转为图片进行预览，以下使其工作流程：
 
 ```sequence 验证码登录逻辑
 actor 客户端
@@ -71,15 +73,14 @@ fast_captcha ->> Redis: 缓存验证码
 Token -->> 客户端: 成功
 ```
 
-## Swagger 登录
+### Swagger 登录
 
-这是一种快捷的授权方式，但仅出于调试目的，在服务启动后，进入 Swagger UI，可通过此调试接口快速获取授权 token（无需验证码）
+这是一种快捷的授权方式，但仅出于调试目的，在服务启动后，进入 Swagger 文档，可通过此调试接口快速获取授权 token（无需验证码）
 
-## OAuth 2.0
+### OAuth 2.0
 
 这种授权方式通常适用于第三方平台认证登录，第三方授权成功后，将依据第三方平台信息自动创建本地用户并自动授权登录，这一切都是用户无感知的
 
-但是，想要使用此方式鉴权，你需要首先了解 OAuth 2.0 相关知识，并遵循第三方平台认证登录要求，获取平台应用和权限，
-最终，使用 [fastapi-oauth20](https://github.com/fastapi-practices/fastapi-oauth20) 完成编码
+但是，想要使用此方式进行授权，你需要先了解 OAuth 2.0 相关知识，并遵循第三方平台认证要求，获取平台应用相关密钥，最终，手动编码完成集成
 
 您可以在代码路径 `backend/app/admin/api/v1/oauth2` 中查看我们的官方实现示例
diff --git a/docs/guide/reference/route.md b/docs/guide/reference/route.md
@@ -16,26 +16,26 @@ FBA 中的路由遵循 Restful API 规范
     - app/ 应用
         - xxx 某自定义应用
             - api 接口
-                - v1（包含子包）
+                - v1 包含子包
                     - xxx 子包
-                        - _\_init\_\_.py 在此文件内导入 xxx.py 中的路由
+                        - __init\_\_.py 在此文件内导入 xxx.py 中的路由器
                         - xxx.py
                         - ...
-                    - xxx/ 子包
                     - ...
                 - v2/
                 - ...
-                - router.py 在此文件内注册所有子包路由
+                - __init\_\_.py
+                - router.py 在此文件内注册所有子包 __init\_\_.py 中的路由
         - xxx 某自定义应用
             - api 接口
-                - v1（不包含子包）
+                - v1 不包含子包
                     - _\_init\_\_.py 不做任何操作
                     - xxx.py
                 - ...
+                - __init\_\_.py
                 - router.py 在此文件内注册所有 xxx.py 中的路由
-        - ...
-    - _\_init\_\_.py
-    - router.py 在此文件内注册所有 app 路由
+    - __init\_\_.py
+    - router.py 在此文件内注册所有 app router.py 中的路由
 
 :::
 
diff --git a/docs/guide/summary/quick-start.md b/docs/guide/summary/quick-start.md
@@ -147,6 +147,11 @@ title: 快速开始
 
 ### 前端
 
+::: tip
+前端项目并不是我们发展的重心，我们创建的所有前端实施，均用于 UI
+效果演示，它们不一定适用于生产环境，您可以点击查看我们的 [目标](./why.md#目标)
+:::
+
 ::::: details Arco Desgin Vue
 
 ::: caution
@@ -190,6 +195,10 @@ title: 快速开始
 
 ::::: details Vben Admin Antd
 
+::: warning
+这是下一代实施，目前正处于积极开发阶段
+:::
+
 1. 准备本地环境
 
     * Nodejs 20.10.0+
@@ -219,7 +228,7 @@ title: 快速开始
 
 ## 开发流程
 
-::: info
+::: tip
 仅供参考，实际以个人为准
 :::
 
diff --git a/docs/guide/summary/why.md b/docs/guide/summary/why.md
@@ -7,16 +7,18 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 </script>
 
 ::: note
-我们不会去和其他架构做比较，我们认为每个架构都有自己的特点，适合不同的场景
-
-我们的目标是提供一个最佳架构，让开发者可以快速上手，能够专注于业务逻辑的开发，所以我们只会不断完善和优化我们的架构，为开发者带来更好的体验
+我们不会去对比其他架构，我们认为每个架构都有自己的特点，适合不同的场景
 :::
 
+## 目标
+
+==我们的目标==是提供一个最佳架构，让开发者可以快速上手，能够专注于业务逻辑开发，或从此架构中获得灵感，优化本地架构设计，所以我们只会不断完善和优化我们的架构，为开发者带来更好的体验
+
 ## 承诺
 
 <div style="text-align: center">
   <h3>「永久 MIT 协议」「永久免授权」</h3>
-  <p>如果可以，请给此项目一个 <NpmBadge repo="fastapi-practices/fastapi_best_architecture" type="stars" />，此仓库作为模板库公开，任何个人或企业均可免费使用！</p>
+  <p>如果可以，请您给此项目一个 <NpmBadge repo="fastapi-practices/fastapi_best_architecture" type="stars" />，此仓库作为模板库公开，任何个人或企业均可免费使用！</p>
   <p style="float: right">--- <a href="https://github.com/fastapi-practices">fastapi-practices</a>对此拥有所有解释权</p>
   <br>
 </div>
@@ -148,7 +150,7 @@ FBA
 
 - 全局使用 reStructuredText 文档风格
 
-  我们采用 rest 的文档风格，这是一种非常流行的 Python 代码文档，并且，与 IDE 有非常好的集成
+  我们采用了 rest 文档风格，这是一种非常流行的 Python 代码文档，并且，与 IDE 有非常好的集成
 
 - 快速同步框架新特性
 
