Skip to content

Commit aa8e99b

Browse files
committed
update docs
1 parent 7d6a04e commit aa8e99b

File tree

2 files changed

+63
-21
lines changed

2 files changed

+63
-21
lines changed

docs/plugin/dev.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: 插件开发
77
:::: steps
88

99
1. 拉取最新的 fba 项目到本地并配置好开发环境
10-
2. 通过 [插件分类](#插件分类)[插件路由结构](#插件路由结构)[插件配置](#插件配置) 了解插件系统的运作机制
10+
2. 通过 [插件分类](#插件分类)[插件路由结构](#插件路由结构)[插件配置](#插件配置)[数据库兼容性](#数据库兼容性) 了解插件系统的运作机制
1111
3. 根据 [插件目录结构](#插件目录结构) 进行插件开发
1212
4. 完成插件开发
1313
5. 插件分享 <Badge type="warning" text="可选" />
@@ -83,6 +83,11 @@ tags = ''
8383

8484
:::
8585

86+
### 数据库兼容性
87+
88+
fba 内所有官方实现都同时兼容 mysql 和 postgresql,但我们不对第三方插件进行强制要求,如果您对此感兴趣,请查看 SQLAlchemy 2.0 官方文档:
89+
[with_variant](https://docs.sqlalchemy.org/en/20/core/type_api.html#sqlalchemy.types.TypeEngine.with_variant)
90+
8691
### 插件目录结构
8792

8893
::: file-tree

docs/plugin/market.md

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@ title: 插件市场
44

55
::: info 标签说明
66

7-
- <Badge type="info" text="free" /> - 免费插件
7+
- <Icon name="logos:mysql" size="1.5em" /> - 支持 MySQL
8+
- <Icon name="vscode-icons:file-type-pgsql" size="1.5em" /> - 支持 PostgreSQL
89
- <Badge type="danger" text="pay" /> - 付费插件
910
- <Badge type="tip" text="fba" /> - 仅后端代码插件
1011
- <Badge text="fba_ui" color="#8e5cd9" bg-color="rgba(159, 122, 234, 0.16)"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 代码插件 <Badge type="warning" text="暂无此计划" />
11-
- <Badge text="app" color="#ff9900"/> - 应用级插件
12-
- <Badge text="extra" color="#11aa00"/> - 扩展级插件
12+
- <Badge text="app" color="var(--vp-c-text-2)" bg-color="rgb(250 150 0 / 38%)"/> - 应用级插件
13+
- <Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/> - 扩展级插件
1314

1415
:::
1516

@@ -21,41 +22,61 @@ title: 插件市场
2122
<Card icon="charm:shield-keyhole" title="Casbin-RBAC">
2223
<p style="color: #898989;">基于 Casbin 实现的 RBAC 权限</p>
2324
<span>
24-
<Badge type="info" text="free" />
25+
<Icon name="logos:mysql" size="1.5em" />
26+
·
27+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
28+
·
2529
<Badge type="tip" text="fba" />
26-
<Badge text="extra" color="#11aa00"/>
30+
·
31+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
2732
</span>
2833
</Card>
2934
<Card icon="fa6-regular:file-code" title="代码生成">
3035
<p style="color: #898989;">生成通用业务代码(目前仅包含后端工程)</p>
3136
<span>
32-
<Badge type="info" text="free" />
37+
<Icon name="logos:mysql" size="1.5em" />
38+
·
39+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
40+
·
3341
<Badge type="tip" text="fba" />
34-
<Badge text="app" color="#ff9900"/>
42+
·
43+
<Badge text="app" color="var(--vp-c-text-2)" bg-color="rgb(250 150 0 / 38%)"/>
3544
</span>
3645
</Card>
3746
<Card icon="fe:notice-active" title="通知公告">
3847
<p style="color: #898989;">发布系统内部通知、公告</p>
39-
<span>
40-
<Badge type="info" text="free" />
48+
<span>
49+
<Icon name="logos:mysql" size="1.5em" />
50+
·
51+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
52+
·
4153
<Badge type="tip" text="fba" />
42-
<Badge text="extra" color="#11aa00"/>
54+
·
55+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
4356
</span>
4457
</Card>
4558
<Card icon="fluent-mdl2:dictionary" title="数据字典">
4659
<p style="color: #898989;">通常用于约束前端工程数据展示</p>
4760
<span>
48-
<Badge type="info" text="free" />
61+
<Icon name="logos:mysql" size="1.5em" />
62+
·
63+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
64+
·
4965
<Badge type="tip" text="fba" />
50-
<Badge text="extra" color="#11aa00"/>
66+
·
67+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
5168
</span>
5269
</Card>
5370
<Card icon="icon-park-outline:config" title="参数配置">
5471
<p style="color: #898989;">通常用于前端工程数据展示</p>
5572
<span>
56-
<Badge type="info" text="free" />
73+
<Icon name="logos:mysql" size="1.5em" />
74+
·
75+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
76+
·
5777
<Badge type="tip" text="fba" />
58-
<Badge text="extra" color="#11aa00"/>
78+
·
79+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
5980
</span>
6081
</Card>
6182
</CardGrid>
@@ -68,17 +89,25 @@ title: 插件市场
6889
<LinkCard icon="ant-design:aliyun-outlined" title="阿里云 oss" href="https://github.com/fastapi-practices/fba_aliyun_oss">
6990
<p style="color: #898989;">阿里云 oss 文件上传</p>
7091
<span>
71-
<Badge type="info" text="free" />
92+
<Icon name="logos:mysql" size="1.5em" />
93+
·
94+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
95+
·
7296
<Badge type="tip" text="fba" />
73-
<Badge text="extra" color="#11aa00"/>
97+
·
98+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
7499
</span>
75100
</LinkCard>
76101
<LinkCard icon="streamline:ai-prompt-spark" title="MCP ChatGPT" href="https://github.com/fastapi-practices/fba_mcp">
77102
<p style="color: #898989;">带有 MCP 服务器调用的 AI 对话</p>
78103
<span>
79-
<Badge type="info" text="free" />
104+
<Icon name="logos:mysql" size="1.5em" />
105+
·
106+
<Icon name="vscode-icons:file-type-pgsql" size="1.5em" />
107+
·
80108
<Badge type="tip" text="fba" />
81-
<Badge text="extra" color="#11aa00"/>
109+
·
110+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
82111
</span>
83112
</LinkCard>
84113
</CardGrid>
@@ -88,6 +117,14 @@ title: 插件市场
88117
这些插件由社区中的开发者提供和维护
89118

90119
<CardGrid>
91-
<Card title="">
92-
</Card>
120+
<LinkCard icon="ant-design:aliyun-outlined" title="配置下发" href="https://github.com/dividduang/option">
121+
<p style="color: #898989;">将 env 等配置信息通过数据库进行管理</p>
122+
<span>
123+
<Icon name="logos:mysql" size="1.5em" />
124+
·
125+
<Badge type="tip" text="fba" />
126+
·
127+
<Badge text="extra" color="var(--vp-c-text-2)" bg-color="rgb(17 170 0 / 38%)"/>
128+
</span>
129+
</LinkCard>
93130
</CardGrid>

0 commit comments

Comments
 (0)