update docs

wu-clan · wu-clan · commit 3c08fd833b19 · 2024-12-20T17:24:17.000+08:00
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -30,7 +30,7 @@ export const mySidebar: SidebarMulti = {
                 {text: '自定义异常', link: 'custom-err-msg', icon: 'mdi:planet'},
                 {text: '接口响应', link: 'response', icon: 'mdi:planet'},
                 {text: '分页', link: 'paginate'},
-                {text: 'Celery', link: 'Celery', icon: 'mdi:planet'},
+                {text: 'Celery', link: 'celery', icon: 'mdi:planet'},
                 {text: 'APScheduler', link: 'apscheduler'},
                 {text: '日志分析', link: 'log', icon: 'mdi:planet'},
                 {text: 'Socketio', link: 'socketio', icon: 'mdi:planet'},
diff --git a/docs/guide/reference/Celery.md b/docs/guide/reference/Celery.md
diff --git a/docs/guide/reference/apscheduler.md b/docs/guide/reference/apscheduler.md
@@ -2,4 +2,4 @@
 title: APScheduler
 ---
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/celery.md b/docs/guide/reference/celery.md
@@ -0,0 +1,17 @@
+---
+title: Celery
+---
+
+<div align="center">
+
+此内容为非公开内容，扫码加入知识星球，即可获取独家内容
+
+<p style="color: rgb(160, 160, 160);">
+请注意，我们不保证星球内容的更新频率，您可以依据星球规则进行全额退款
+<br/>
+附：加入 Discord 频道，可领取免费体验资格
+</p>
+
+<img height="349" width="415" src="https://wu-clan.github.io/picx-images-hosting/知识星球.png" alt="知识星球">
+
+</div>
diff --git a/docs/guide/reference/custom-err-msg.md b/docs/guide/reference/custom-err-msg.md
@@ -4,4 +4,4 @@ title: 自定义异常
 
 [//]: # (星球)
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/db.md b/docs/guide/reference/db.md
@@ -2,4 +2,4 @@
 title: 切换数据库
 ---
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/log.md b/docs/guide/reference/log.md
@@ -4,4 +4,4 @@ title: 日志分析
 
 [//]: # (星球)
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/paginate.md b/docs/guide/reference/paginate.md
@@ -2,4 +2,4 @@
 title: 分页
 ---
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/response.md b/docs/guide/reference/response.md
@@ -2,4 +2,4 @@
 title: 接口响应
 ---
 
-建设中...
+coming soon...
diff --git a/docs/guide/reference/socketio.md b/docs/guide/reference/socketio.md
@@ -4,4 +4,4 @@ title: Socketio
 
 [//]: # (星球)
 
-建设中...
+coming soon...
diff --git a/docs/guide/summary/why.md b/docs/guide/summary/why.md
@@ -1,6 +1,7 @@
 ---
 title: 为什么选择我们？
 ---
+
 <script setup>
 import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 </script>
@@ -22,7 +23,7 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 <div style="text-align: center">
   <h3>「永久 MIT 协议」「永久免授权」</h3>
   <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>
+  <p style="float: right">--- <a href="https://github.com/fastapi-practices">fastapi-practices</a>对此拥有所有解释权</p>
   <br>
 </div>
 
@@ -36,11 +37,102 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 
 ![Commits_over_time.png](/images/Commits_over_time.png)
 
-## 框架历程
-
-建设中...
-
-我们有一个完整的关于 FBA 由来的 issue，但它已被删除且无法到达 😭
+## 框架由来
+
+我们有一个完整的关于 FBA 由来的 [issue](https://github.com/wu-clan/fastapi_sqlalchemy_mysql/issues/5)，但它被不小心删除且无法到达
+😭，我们尝试联系了 GitHub 支持，但我们只能获取 issue 问题本身的正文 😭
+
+大致内容为我们的核心团队成员 [downdawn](https://github.com/downdawn) 在 FBA 创建之前，找到了 FBA 现在的精简版
+[fastapi_sqlalchemy_mysql](fsm.md#sqlalchemy)，并创建了 issue：==几点讨论与建议==；我们就此 issue 展开了为期数天的讨论，最终决定并创建了
+FBA
+
+::: details issue 正文（由 GitHub 支持提供，无法保证原始性）
+> ==讨论一：更清晰的结构建议==
+>
+>现在的api结构是：
+>
+>```
+>api
+> ═── service/
+> ═── v1
+> │ ═── auth
+> ═── init .py
+> ═──casbin.py
+> ═──jwt.py
+> ═──registrar.py
+> ═──routers.py
+>```
+>
+>参考几个开源项目，结合个人建议是api目录下保留最简单的结构，casbin、jwt、registrar可以移动到其他目录，比如core。
+>
+>api <br/>
+> │ <br/>
+> ...
+>
+>api——>初始化.py
+>
+>```python
+>from fastapi import APIRouter
+>from api.auth import router as auth_router
+>
+>v1 = APIRouter(prefix='/v1')
+>
+>v1.include_router(auth_router)
+>```
+>
+>api——>v1——>auth——>初始化.py
+>
+>```python
+>from fastapi import APIRouter
+>from api.auth.user import router as user_router
+>
+>router = APIRouter(prefix='/auth', tags=['认证'])
+>
+>router.include_router(user_router, prefix='/user')
+>```
+>
+>==讨论二：基于类的视图==
+>
+>参考该讨论：https://github.com/zhanymkanov/fastapi-best-practices/issues/4与fastapi-utils项目
+>
+>基于类的比每个零散的方法看起来会更加清晰，并且可以在一个py管理多个路由（有时需要）
+>
+>```python
+>from utils.cvb import cbv
+>
+>router = APIRouter(prefix='/api')
+>
+>
+>@cbv(router)
+>class APIRouter:
+>user: User = Depends(get_current_user)
+>service = ApiService()
+>
+>@router.get('', summary='获取所有API', response_model=Page[GetAllApi])
+>async def get_all_api(self):
+>print(self.user)
+>return await self.service.get_api_list()
+>```
+>
+>如上，原先的service文件里的方法也封装成ApiService类。同时建议service应该每个路由模块里都有一个，类似如下结构：
+>
+>api <br/>
+> │ │ │ <br/>
+> │ │ │ │ │ │ │ │ <br/>
+> │ │ │ │ │ │ │ │ │ │
+>
+>这样的话，应该有个Service基类，包含常见的query、create、update、delete方法。
+>
+>同时async with async_db_session.begin() as db:每个方法都有，可以进一步优化？
+>
+> ==讨论三：权限==
+>
+>casbin是go项目扩展出来的思想？感觉有点冗重，权限这块自己封装比较好自定义。
+>
+>简单的基于redis或者mysql定义crud，可以对不同路由或者请求方法设置不同的权限。
+>
+>目前还没有很好的实现方法，但是参考过往的项目应该不难。
+:::
 
 ## 套件产物
 
@@ -55,22 +147,25 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
 
 ## 精简版
 
-尽管我们在 FBA 中尽可能地降低了耦合度，但是对于一个简易版本来讲，它需要删除太多东西，因此，我们同时提供了精简版本，详情请查看：[精简版](./fsm.md)
+尽管我们在 FBA
+中尽可能地降低了耦合度，但是对于一个简易版本来讲，它需要删除太多东西，因此，我们同时提供了精简版本，详情请查看：[精简版](./fsm.md)
 
 ## 质量与规范
 
 - 全局使用 reStructuredText 文档风格
 
-    我们采用 rest 的文档风格，这是一种非常流行的 Python 代码文档，并且，与 IDE 有非常好的集成
+  我们采用 rest 的文档风格，这是一种非常流行的 Python 代码文档，并且，与 IDE 有非常好的集成
 
 - 快速同步框架新特性
 
-    我们追求新事物，拥抱新事物，我们会积极跟进 FastAPI 中的新特性，在不受 Issue 影响的情况下，尽可能地将所有好用的新特性集成进来
+  我们追求新事物，拥抱新事物，我们会积极跟进 FastAPI 中的新特性，在不受 Issue 影响的情况下，尽可能地将所有好用的新特性集成进来
 
 - 严格的代码质量
 
-    我们有十分严格的 CI 代码质量检测和[规则](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/.ruff.toml)，使用非常流行且强大的 ruff 作为支撑，为每次 PR 的代码质量做到严格把控
+  我们有十分严格的 CI
+  代码质量检测和[规则](https://github.com/fastapi-practices/fastapi_best_architecture/blob/master/backend/.ruff.toml)
+  ，使用非常流行且强大的 ruff 作为支撑，为每次 PR 的代码质量做到严格把控
 
 - 持续的认可
 
-    在此我们不做任何宣传引导，您可以在交流群发出疑问，我们静待用户真实反馈
+  在此我们不做任何宣传引导，您可以在交流群发出疑问，我们静待用户真实反馈
diff --git a/docs/team.md b/docs/team.md
@@ -4,39 +4,43 @@ title: FastAPI Practices
 description: FastAPI Practices 及其生态系统发展的背后是一个由开源社区人员组成的团队，我们对团队中的任何成员以及所有的关注者都致以崇高的敬意；
   我们欢迎每一位开源伙伴的加入，请查看：关于 -> 申请加入
 groups:
-  -
-    title: 核心团队成员
+  - title: 核心团队成员
     desc: 核心团队成员是那些积极参与维护一个或多个核心项目的人，他们对项目做出了重大贡献
     list:
-      -
-        name: wu-clan
+      - name: wu-clan
         link: https://wu-clan.github.io/homepage/
         avatar: https://avatars.githubusercontent.com/u/52145145?v=4
         desc: 一个喜欢在夜深人静时进行开源创作的 coder
         location: 郑州，河南
         organization: FastAPI Practices
         socials: [
-          {icon: 'github', link: 'https://github.com/wu-clan'},
-          {icon: 'x', link: 'https://twitter.com/_chulan'},
-          {icon: 'juejin', link: 'https://juejin.cn/user/3940246036158974'},
-          {icon: 'bilibili', link: 'https://space.bilibili.com/284237214'}
+          { icon: 'github', link: 'https://github.com/wu-clan' },
+          { icon: 'x', link: 'https://twitter.com/_chulan' },
+          { icon: 'juejin', link: 'https://juejin.cn/user/3940246036158974' },
+          { icon: 'bilibili', link: 'https://space.bilibili.com/284237214' }
         ]
-      -
-        name: dowdawn
+      - name: dowdawn
         link: https://blog.csdn.net/qq_42280510?type=blog
         avatar: https://avatars.githubusercontent.com/u/41266749?v=4
         desc: AI 全干工程狮
         location: 厦门，福建
         organization: FastAPI Practices
         socials: [
-          {icon: 'github', link: 'https://github.com/downdawn'}
+          { icon: 'github', link: 'https://github.com/downdawn' }
         ]
-  - 
-    title: 名誉核心团队
+  - title: 名誉核心团队
     desc: 我们在此致敬过去曾做出过突出贡献的不再活跃的团队成员
     list:
-  - 
-    title: 社区伙伴
+  - title: 社区伙伴
     desc: 一些 FastAPI Practices 的社区成员让这里变得更加丰富多彩，有必要在此特别提及。我们与这些主要合作伙伴建立了更加亲密的关系，经常与他们就即将到来的功能和新闻展开协作
     list:
+      - name: 向申
+        link: https://github.com/xiangshen123
+        avatar: https://avatars.githubusercontent.com/u/124766156?v=4
+        desc: 运维开发工程师，开发语言 Python，目前开发能力不是很高，自己写一个运维平台
+        location: 成都，四川
+        organization: --
+        socials: [
+          { icon: 'github', link: 'https://github.com/xiangshen123' }
+        ]
 ---

Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ title: 自定义异常`
`4`	`4`
`5`	`5`	`[//]: # (星球)`
`6`	`6`
`7`		`-建设中...`
	`7`	`+coming soon...`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ title: 日志分析`
`4`	`4`
`5`	`5`	`[//]: # (星球)`
`6`	`6`
`7`		`-建设中...`
	`7`	`+coming soon...`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ title: Socketio`
`4`	`4`
`5`	`5`	`[//]: # (星球)`
`6`	`6`
`7`		`-建设中...`
	`7`	`+coming soon...`