update docs

wu-clan · wu-clan · commit 03d8bdb98094 · 2025-04-27T13:19:58.000+08:00
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -40,7 +40,7 @@ export const mySidebar: ThemeSidebarMulti = {
                 { text: 'JWT', link: 'jwt' },
                 { text: 'RBAC', link: 'RBAC' },
                 { text: 'OAuth 2.0', link: 'oauth2' },
-                { text: '数据规则', link: '/planet', icon: 'fluent-color:video-16' },
+                { text: '数据权限', link: '/planet', icon: 'fluent-color:video-16' },
                 { text: '代码生成', link: 'code-generation' },
                 { text: '跨域', link: 'CORS' },
                 { text: '事务', link: 'transaction' },
diff --git a/docs/README.md b/docs/README.md
@@ -32,9 +32,9 @@ config:
       - title: JWT
         icon: 🔏
         details: 带有缓存和白名单的 JWT 授权中间件
-      - title: RBAC
+      - title: 权限管理
         icon: 🛠️
-        details: 提供 Casbin、Role-Menu 两种 RBAC 方案
+        details: RBAC 解决方案和十分高级的数据权限
       - title: 代码生成
         icon: ⚙️
         details: 内置代码自动生成，告别通用代码频繁 cv
diff --git a/docs/backend/reference/RBAC.md b/docs/backend/reference/RBAC.md
@@ -2,35 +2,19 @@
 title: RBAC
 ---
 
-我们通过自定义依赖组件，实现了 RBAC 的轻松集成，在 Java 或其他语言中，常见的方式可能是注解，但在 FastAPI 中，Depends
-是它的亮点，也是核心
+我们通过自定义依赖组件，实现了 RBAC 的轻松集成，它可以通过 FastAPI Depends 轻松集成
 
-## RBAC
-
-fba 内置了两种解决方案，分别为【角色菜单】、【Casbin】
-
-::: tip
-fba 中默认使用【Casbin】进行鉴权，管理员用户不受控，默认拥有所有访问权限
+::: warning
+自 fba `v1.1.2` 版本起，开始使用【角色菜单】作为默认 RBAC 鉴权，Casbin 将作为外置插件进行分发
 :::
 
-### 角色菜单
-
-此方案是各类语言 web 开发中比较常见的解决方案，它可以设置按钮级别的控制规则
+## 角色菜单
 
-要想实现此 RBAC 鉴权，需要修改以下相关配置
+要想实现此 RBAC 鉴权，需要进行以下配置
 
 ::: steps
 
-1. 更新 RBAC 鉴权配置
-
-   在 `core/conf.py` 文件中找到以下配置，并更新 `RBAC_ROLE_MENU_MODE` 为 `True`
-
-   ```py
-   # Permission (RBAC)
-   RBAC_ROLE_MENU_MODE: bool = False
-   ```
-
-2. 添加接口依赖
+1. 添加接口依赖
 
    只有在接口中添加以下依赖时，才能自动调用此鉴权方式
 
@@ -45,100 +29,22 @@ fba 中默认使用【Casbin】进行鉴权，管理员用户不受控，默认
    )
    ```
 
-3. 在系统菜单中添加权限标识
+2. 在系统菜单中添加权限标识
 
-   我们在接口依赖中可以看到 `sys:api:add` 之类的值，这些值正是对应着菜单中的权限标识，
-   只有它们完全一致，并且用户拥有对应的菜单时，才会获得相应的操作权限
+   我们在接口依赖中可以看到 `sys:api:add` 之类的值，这些值正是对应着菜单中的权限标识，只有它们完全一致，并且用户拥有对应的菜单时，才可以获得相应的操作权限
 
 :::
 
-### Casbin
-
-此方案是 Go 语言中比较流行的解决方案，它非常灵活，可以通过模型定义多种控制规则
-
-要想使用此 RBAC 鉴权，需要学习以下几点
-
-::: steps
-
-1. 了解 Casbin
-
-   我们在最初架构设计时，参考了 go-admin，gin-vue-admin... 等优秀的开源项目，同时引入了 Casbin，它在众多 python web
-   开源项目中可能是极为罕见的，并且，它的学习成本非常高，如果你对此感兴趣，可以通过 [Casbin 官网](https://casbin.org/docs/get-started)
-   进行学习，另外，可参考视频教程 [半小时彻底弄懂 Casbin 基础模型](https://www.bilibili.com/video/BV1qz4y167XP/?spm_id_from=333.999.0.0&vd_source=958c4d7f9243c68a0ec9dcd327bad930)、[Casbin 的代码使用、api 调用、自定义比较方法](https://www.bilibili.com/video/BV13r4y1M7AC/?spm_id_from=333.999.0.0&vd_source=958c4d7f9243c68a0ec9dcd327bad930)
-   ，讲的是非常好
-
-2. 了解规则
-
-   通过以上学习之后，我们再来看内置规则（不学习 == 天书），你可以通过[编辑器](https://casbin.org/zh/docs/online-editor)
-   进行模型规则验证
-
-   内置模型 `backend/plugin/casbin/utils/rbac.py`：
-
-   ```text:no-line-numbers
-   [request_definition]
-   r = sub, obj, act
-
-   [policy_definition]
-   p = sub, obj, act
-
-   [role_definition]
-   g = _, _
-
-   [policy_effect]
-   e = some(where (p.eft == allow))
-
-   [matchers]
-   m = g(r.sub, p.sub) && (keyMatch(r.obj, p.obj) || keyMatch3(r.obj, p.obj)) && (r.act == p.act || p.act == "*")
-   ```
-
-3. 了解策略
-   ::: tabs
-   @tab p 策略
-
-    - 添加基于角色的访问权限（推荐）
-
-      需要配合添加 g 策略才能实现用户访问权限，适合配置所有用户接口访问策略，拥有此角色的用户便能拥有相应的访问权限<br>
-
-      格式：`角色 role + 访问路径 path + 访问方法 method`
-
-    - 添加基于用户的访问权限（不推荐）
-
-      不需要配合添加 g 策略就能实现用户访问权限，适合配置指定用户接口访问策略<br>
-
-      格式：`用户 uuid + 访问路径 path + 访问方法 method`
-
-   @tab g 策略
-   当 p 策略为【添加基于角色的访问权限】时，需要此策略
-
-   格式：`用户 uuid + 角色 role`
-
-4. 添加策略
+## Casbin
 
-   在文件 `backend/plugin/casbin/api/v1/sys/casbin.py` 中，包含策略相关接口，依据模型和策略规则添加相关策略即可
-
-5. 检查接口依赖
-
-   只有在接口中添加以下依赖时，才能自动调用此鉴权方式
-
-   ```python{1}
-   @router.post('/hello', summary='你好', dependencies=[DependsRBAC])
-   async def hello():
-       ....
-   ```
-
-:::
+此方案是 Go 语言中比较流行的解决方案，它非常灵活，可以通过模型定义多种控制规则，要想实现此 RBAC
+鉴权，请通过 [插件市场](../../plugin/market.md) 获取
 
 ## 解耦
 
-在实际项目开发中，不可能同时存在两种 RBAC 解决方案，我们可以通过以下方式删除其中一种集成
-
-### 角色菜单
+在实际项目开发中，不可能同时存在多种 RBAC 解决方案，您可以通过以下方式删除【角色菜单】集成
 
 - 删除 `backend/common/security/permission.py` 文件中的 `RequestPermission` 类及所有类调用
 - 删除 `backend/core/conf.py` 文件中的 `RBAC_ROLE_MENU_MODE` 和 `RBAC_ROLE_MENU_EXCLUDE`
 - 删除 `backend/common/security/rbac.py` 文件中 `rbac_verify` 方法里面的 `if settings.RBAC_ROLE_MENU_MODE:`
   条件及相关代码
-
-### Casbin
-
-删除 `backend/plugin/casbin` 文件夹
diff --git a/docs/backend/reference/schema.md b/docs/backend/reference/schema.md
@@ -8,12 +8,12 @@ title: schema
 
 fba 遵循以下命名规范：
 
-- 基础 schema: `XxxSchemaBase(SchemaBase)`
-- 接口入参：`XxxParam(XxxSchemaBase)`
-- 新增入参：`CreateXxxParam(XxxSchemaBase)`
-- 更新入参：`UpdateXxxParam(XxxSchemaBase)`
-- 查询详情：`GetXxxDetail(XxxSchemaBase)`
-- 查询详情（包含关系）：`GetXxxWithRelationDetail(XxxSchemaBase)`
+- 基础 schema: `(SchemaBase)`
+- 接口入参：`XxxParam()`
+- 新增入参：`CreateXxxParam()`
+- 更新入参：`UpdateXxxParam()`
+- 查询详情：`GetXxxDetail()`
+- 查询详情（包含关系）：`GetXxxWithRelationDetail()`
 
 ## Field
 
diff --git a/docs/backend/summary/intro.md b/docs/backend/summary/intro.md
@@ -27,8 +27,7 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 - [x] 遵循 RESTful API 规范
 - [x] 使用 SQLAlchemy 2.0 全新语法
 - [x] 使用 Pydantic v2 版本
-- [x] 实现角色菜单 RBAC 访问控制
-- [x] 集成 Casbin RBAC 访问控制
+- [x] 角色菜单 RBAC 访问控制
 - [x] 支持 Celery 异步任务
 - [x] 自研 JWT 认证中间件
 - [x] 支持全局自定义时间时区
diff --git a/docs/frontend/process.md b/docs/frontend/process.md
@@ -15,8 +15,7 @@ badge:
 - [ ] 用户管理 <Badge text="优先" />
 - [ ] 角色管理
 - [ ] 菜单管理 <Badge text="优先" />
-- [ ] 数据规则
-- [ ] Casbin RBAC <Badge text="延迟" type="warning" />
+- [ ] 数据权限
 - [x] 登录日志
 - [x] 操作日志
 - [x] 系统监控
diff --git a/docs/planet.md b/docs/planet.md
@@ -45,7 +45,7 @@ aside: false
     description="优雅的使用 Celery" 
     />
   <LinkCard 
-    title="数据规则" 
+    title="数据权限" 
     icon="fluent-color:video-16" 
     href="https://t.zsxq.com/qlZyT"
     description="超灵活的行级数据权限"
diff --git a/docs/plugin/market.md b/docs/plugin/market.md
@@ -18,18 +18,6 @@ aside: false
 ## 内置
 
 <CardGrid>
-  <Card icon="charm:shield-keyhole" title="Casbin-RBAC">
-    <p style="color: #898989;">基于 Casbin 实现的 RBAC 权限</p>
-    <span>
-    <Icon name="logos:mysql" size="1.5em" />
-    ·
-    <Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
-    ·
-    <Badge type="tip" text="fba" />
-    ·
-    <Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
-    </span>
-  </Card>
   <Card icon="fa6-regular:file-code" title="代码生成">
     <p style="color: #898989;">生成通用业务代码（目前仅包含后端工程）</p>
     <span>
@@ -85,6 +73,18 @@ aside: false
 这些插件由 fba 开发人员提供和维护
 
 <CardGrid>
+  <LinkCard icon="charm:shield-keyhole" title="Casbin-RBAC" href="https://github.com/fastapi-practices/fba_casbin">
+    <p style="color: #898989;">基于 Casbin 实现的 RBAC 权限</p>
+    <span>
+    <Icon name="logos:mysql" size="1.5em" />
+    ·
+    <Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
+    ·
+    <Badge type="tip" text="fba" />
+    ·
+    <Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
+    </span>
+  </LinkCard>
   <LinkCard icon="ant-design:aliyun-outlined" title="阿里云 oss" href="https://github.com/fastapi-practices/fba_aliyun_oss">
     <p style="color: #898989;">阿里云 oss 文件上传</p>
     <span>
diff --git a/docs/sponsors.md b/docs/sponsors.md
@@ -21,7 +21,7 @@ font-family: sans-serif;
 text-decoration: none;
 border: 1px solid #5D3408;
 display: inline-block;
-">☕ 来杯小瑞幸</a>
+">来杯 ☕</a>
 
 ::: info
 我在 Linux Do 发了一篇主题：[FastAPI 最佳架构](https://linux.do/t/topic/470425?u=wu-clan)
