Skip to content

Commit 02fb66d

Browse files
committed
update docs
1 parent 363a044 commit 02fb66d

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

docs/guide/reference/RBAC.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: RBAC
66

77
## RBAC
88

9-
RBAC 提供了两种解决方案,分别为【角色菜单】、【Casbin】
9+
RBAC 内置了两种解决方案,分别为【角色菜单】、【Casbin】
1010

1111
【角色菜单】是各类语言 web 开发中比较常见的解决方案,它可以设置按钮级别的控制规则
1212

@@ -20,11 +20,11 @@ RBAC 提供了两种解决方案,分别为【角色菜单】、【Casbin】
2020

2121
1. 更新 RBAC 鉴权配置
2222

23-
`core/conf.py` 文件中找到以下配置,并更新 `PERMISSION_MODE``role-menu`
23+
`core/conf.py` 文件中找到以下配置,并更新 `RBAC_ROLE_MENU_MODE``True`
2424

2525
```py
2626
# Permission (RBAC)
27-
PERMISSION_MODE: Literal['casbin', 'role-menu'] = 'role-menu'
27+
RBAC_ROLE_MENU_MODE: bool = False
2828
```
2929

3030
2. 添加接口依赖
@@ -42,7 +42,7 @@ RBAC 提供了两种解决方案,分别为【角色菜单】、【Casbin】
4242
)
4343
```
4444

45-
3. 在菜单中添加权限标识
45+
3. 在系统菜单中添加权限标识
4646

4747
我们在接口依赖中可以看到 `sys:api:add` 之类的值,这些值正是对应着菜单中的权限标识,
4848
只有它们完全一致,并且用户拥有对应的菜单时,才会获得相应的操作权限
@@ -103,17 +103,11 @@ g 策略 (**依赖 p 策略**):
103103
### 角色菜单
104104
105105
- 删除 `backend/common/security/permission.py` 文件中的 `RequestPermission` 类及所有类调用
106-
- 删除 `backend/core/conf.py` 文件中的 `PERMISSION_MODE` 和 `RBAC_ROLE_MENU_EXCLUDE`
107-
- 删除 `backend/common/security/rbac.py` 文件中 `rbac_verify` 方法里面的 `if settings.PERMISSION_MODE == 'role-menu':`
106+
- 删除 `backend/core/conf.py` 文件中的 `RBAC_ROLE_MENU_MODE` 和 `RBAC_ROLE_MENU_EXCLUDE`
107+
- 删除 `backend/common/security/rbac.py` 文件中 `rbac_verify` 方法里面的 `if settings.RBAC_ROLE_MENU_MODE:`
108108
条件及相关代码
109109
110110
### Casbin
111111
112-
- 删除 `backend/app/admin/api/v1/sys/casbin.py`、`backend/app/admin/crud/crud_casbin.py`、
113-
`backend/app/admin/model/casbin_rule.py`、`backend/app/admin/schema/casbin_rule.py`、
114-
`backend/app/admin/service/casbin_service.py` 文件
115-
- 删除 `backend/core/conf.py` 文件中的 `RBAC_CASBIN_EXCLUDE`
116-
- 删除 `backend/common/security/rbac.py` 文件中 `enforcer` 方法
117-
- 删除 `backend/common/security/rbac.py` 文件中 `rbac_verify` 方法里面的 `if settings.PERMISSION_MODE == 'role-menu':`
118-
条件和 else 条件中的相关代码
119-
- 删除 casbin 相关依赖包
112+
- 删除 `backend/plugin/casbin` 文件夹
113+
- 删除 `backend/common/security/rbac.py` 文件中的 `casbin_verify` 相关代码

docs/plugin/dev.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ title: 插件开发
4040
- …
4141
- schema/ 数据传输
4242
- service/ 服务
43+
- utils/ 工具包,如果插件无需独立工具,则无需此目录
4344
- \_\_init__.py 作为 python 包保留(必填项)
4445
- conf.py 配置,如果插件不需要独立配置,则无需此文件
4546
- plugin.toml 插件配置(必填项)

docs/plugin/market.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,14 @@ title: 插件市场
2424

2525
<CardGrid>
2626
<LinkCard title="通知公告" href="https://discord.com/channels/1185035164577972344/1336557178437373984">
27-
<p>添加后台通知公告功能</p>
27+
<p>添加通知公告功能</p>
28+
<span>
29+
<Badge type="info" text="free" />
30+
<Badge type="tip" text="fba" />
31+
</span>
32+
</LinkCard>
33+
<LinkCard title="Casbin-RBAC" href="https://discord.com/channels/1185035164577972344/1340300371251302451">
34+
<p>添加基于 Casbin 实现的 RBAC 权限</p>
2835
<span>
2936
<Badge type="info" text="free" />
3037
<Badge type="tip" text="fba" />

0 commit comments

Comments
 (0)