Skip to content

Commit 57b731f

Browse files
committed
update docs
1 parent bf049d9 commit 57b731f

File tree

13 files changed

+29
-29
lines changed

13 files changed

+29
-29
lines changed

docs/guide/reference/CRUD.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: CRUD
33
---
44

5-
我们在 FBA 中使用 sqlalchemy-crud-plus 作为数据库操作基类,
5+
我们在 fba 中使用 sqlalchemy-crud-plus 作为数据库操作基类,
66
它是一款由我们自主构建的基于 SQLAlchemy 2.0 的高级异步 CRUD SDK,它适用于所有 FastAPI + SQLAlchemy 项目
77

88
<RepoCard repo="fastapi-practices/sqlalchemy-crud-plus" />

docs/guide/reference/db.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ title: 切换数据库
66
此教程仅适用于 pg 用户
77
:::
88

9-
FBA 支持 MySQL、PostgreSQL 两种数据库,默认配置使用 MySQL
9+
fba 支持 MySQL、PostgreSQL 两种数据库,默认配置使用 MySQL
1010

1111
如果本地未安装 pg,你可以使用以下命令创建 Docker 镜像
1212

docs/guide/reference/jwt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ class JwtAuthMiddleware(AuthenticationBackend):
5252

5353
您可以通过验证码登录获取 token,在大多数情况下,这更适用于配合前端实现登录授权
5454

55-
我们在 FBA 中使用 [fast_captcha](https://github.com/wu-clan/fast-captcha) 生成 base64 验证码,通过接口进行数据返回;您可以通过在线
55+
我们在 fba 中使用 [fast_captcha](https://github.com/wu-clan/fast-captcha) 生成 base64 验证码,通过接口进行数据返回;您可以通过在线
5656
base64 转图片或配合前端项目将其转为图片进行预览,以下使其工作流程:
5757

5858
```sequence 验证码登录逻辑

docs/guide/reference/response.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 接口响应
33
---
44

5-
我们为 FBA 开发了十分灵活且健全的接口响应系统,它同时适用于任何 FastAPI 应用
5+
我们为 fba 开发了十分灵活且健全的接口响应系统,它同时适用于任何 FastAPI 应用
66

77
## 统一返回模型
88

docs/guide/reference/router.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: 路由
33
---
44

5-
FBA 中的路由遵循 Restful API 规范
5+
fba 中的路由遵循 Restful API 规范
66

77
## 路由结构
88

@@ -39,6 +39,6 @@ FBA 中的路由遵循 Restful API 规范
3939
::: warning
4040
我们统一命名了所有接口路由参数为 router,这很有助于我们编写接口,但是,不可忽略的是,在注册路由时,一定要注意我们的导入方式
4141

42-
FBA 中,我们可以查看所有路由的导入,它们看起来像 `from backend.app.admin.api.v1.sys.api import router as api_router`
42+
fba 中,我们可以查看所有路由的导入,它们看起来像 `from backend.app.admin.api.v1.sys.api import router as api_router`
4343
,我们这里务必导入文件内的路由参数 `router`,为了避免参数名称冲突,我们可以使用 `as` 为路由参数起一个别名
4444
:::

docs/guide/reference/transaction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,6 @@ async def create(*, obj: CreateIns) -> None:
4949

5050
以上两种方法,我们更推荐第二种;
5151

52-
对于 FBA 来说,它更加符合架构风格,并且也能减少千篇一律的接口参数(纯作者强迫症)
52+
对于 fba 来说,它更加符合架构风格,并且也能减少千篇一律的接口参数(纯作者强迫症)
5353

5454
而对于无需使用自动提交的事务,我们只需将 `begin()` 方法去掉,直接使用 `async_db_session()` 即可

docs/guide/summary/fsm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ FastAPI 三层架构脚手架精简版的更新可能并不同步,你可能无
1111
1212
## SQLAlchemy
1313

14-
==推荐== 如果您正在使用 SQLAlchemy,请使用以下版本,并且它的维护频率较高,且由 FBA 作者积极维护
14+
==推荐== 如果您正在使用 SQLAlchemy,请使用以下版本,并且它的维护频率较高,且由 fba 作者积极维护
1515

1616
<RepoCard repo="fastapi-practices/fastapi_sqlalchemy_mysql" />
1717

docs/guide/summary/why.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ import NpmBadge from 'vuepress-theme-plume/features/NpmBadge.vue'
3535

3636
## 框架由来
3737

38-
我们有一个完整的关于 FBA 由来的 [issue](https://github.com/fastapi-practices/fastapi_sqlalchemy_mysql/issues/5)
38+
我们有一个完整的关于 fba 由来的 [issue](https://github.com/fastapi-practices/fastapi_sqlalchemy_mysql/issues/5)
3939
,但它被不小心删除且无法到达 😭,我们尝试联系了 GitHub 支持,但我们只能获取 issue 问题本身的正文 😭
4040

41-
大致内容为我们的核心团队成员 [downdawn](https://github.com/downdawn)FBA 创建之前,找到了 FBA 现在的精简版
41+
大致内容为我们的核心团队成员 [downdawn](https://github.com/downdawn)fba 创建之前,找到了 fba 现在的精简版
4242
[fastapi_sqlalchemy_mysql](fsm.md#sqlalchemy),并创建了 issue:==几点讨论与建议==;我们就此 issue 展开了为期数天的讨论,最终决定并创建了
43-
FBA
43+
fba
4444

4545
::: details issue 正文(由 GitHub 支持提供,无法保证原始性)
4646
> ==讨论一:更清晰的结构建议==
@@ -132,7 +132,7 @@ FBA
132132
133133
## 套件产物
134134
135-
在创建和迭代 FBA 的同时,我们创建了很多与之相关的套件,且他们非常实用,并且我们做到了 0 耦合,您完全可以将它们用到其他与之相关的项目中去
135+
在创建和迭代 fba 的同时,我们创建了很多与之相关的套件,且他们非常实用,并且我们做到了 0 耦合,您完全可以将它们用到其他与之相关的项目中去
136136
137137
<CardGrid>
138138
<RepoCard repo="fastapi-practices/sqlalchemy-crud-plus" />
@@ -143,7 +143,7 @@ FBA
143143
144144
## 精简版
145145
146-
尽管我们在 FBA
146+
尽管我们在 fba
147147
中尽可能地降低了耦合度,但是对于一个简易版本来讲,它需要删除太多东西,因此,我们同时提供了精简版本,详情请查看:[精简版](./fsm.md)
148148
149149
## 质量与规范

docs/planet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ title: 知识星球
2222
- <Icon name="fluent-color:video-16" /> 带有视频讲解的文章
2323

2424

25-
### FBA 专属
25+
### fba 专属
2626

2727
<CardGrid>
2828
<LinkCard

docs/plugin/dev.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22
title: 插件开发
33
---
44

5-
::: warning
6-
当前插件开发要求于 2025-02-14 进行定义,一旦修改,我们会立即同步此文档
7-
:::
8-
95
## 后端
106

117
我们创建了一个插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
@@ -16,7 +12,11 @@ title: 插件开发
1612
1. clone 最新 fba 项目到本地并配置好开发环境
1713
2. 根据插件模板的 [目录结构](#插件目录结构) 和其他配置说明进行插件开发
1814
3. 完成插件开发
19-
4. 使用插件模板仓库创建个人仓库,并将插件代码更新至个人仓库
15+
4. 常见插件仓库
16+
17+
::: warning
18+
使用插件模板仓库创建个人仓库,并将插件代码更新至个人仓库!请不要将插件代码以 PR 的方式进行提交!
19+
:::
2020

2121
::: note
2222
我们鼓励大家将插件源码进行开源,但并不强制,如果您的插件需要付费,则无需上传源码,但必须保留个人仓库,并添加相关付费说明

0 commit comments

Comments
 (0)