update docs

wu-clan · wu-clan · commit da774c6f1f5b · 2025-03-11T18:55:13.000+08:00
diff --git a/docs/.vuepress/bulletin.ts b/docs/.vuepress/bulletin.ts
@@ -1,10 +1,9 @@
 import {BulletinOptions} from "vuepress-theme-plume";
 
 export const myBulletin: BulletinOptions = {
-    layout: 'bottom-right',
     enablePage: true,
     lifetime: 'session',
     contentType: 'markdown',
-    // title: 'Vben Admin Antd',
-    content: '欢迎大家闲聊，分享，提供建议，高频艾特，你们的活跃度是我更新的动力',
+    title: 'FasAPI 最佳架构',
+    content: '欢迎大家闲聊，分享，提供建议，高频艾特，你们的活跃度是我更新的动力 🌹',
 }
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -25,9 +25,9 @@ export const mySidebar: SidebarMulti = {
                 {text: '分页', link: 'pagination'},
                 {text: '自定义异常', link: '/planet', icon: 'fluent-color:receipt-16'},
                 {text: '切换数据库', link: 'db'},
+                {text: '鉴权', link: 'permission'},
                 {text: 'JWT', link: 'jwt'},
                 {text: 'RBAC', link: 'RBAC'},
-                {text: '鉴权', link: 'permission'},
                 {text: '数据规则', link: '/planet', icon: 'fluent-color:video-16'},
                 {text: '代码生成', link: 'code-generation'},
                 {text: '跨域', link: 'CORS'},
diff --git a/docs/guide/deploy/Docker.md b/docs/guide/deploy/Docker.md
@@ -24,13 +24,13 @@ title: Docker 部署
 
    在 `backend` 目录中，创建环境变量文件
 
-   ```shell
+   ```shell:no-line-numbers
    touch .env
    ```
 
    将初始化环境变量配置拷贝到环境变量文件中
 
-   ```shell
+   ```shell:no-line-numbers
    cp .env.example .env
    ```
 
@@ -40,15 +40,15 @@ title: Docker 部署
 
    如果容器要在本地启动，需要将 `.env` 中的 `127.0.0.1` 更改为 `host.docker.internal`
 
-   ```shell
-   docker build -f backend/Dockerfile -t fba_backend_independent .
+   ```shell:no-line-numbers
+   docker build -f Dockerfile -t fba_backend_independent .
    ```
 
 5. 启动容器
 
    由于构建不包含数据库，请确保本地已安装并启动相关数据库（mysql / postgresql、redis）
 
-   ```shell
+   ```shell:no-line-numbers
    docker run -d -p 8000:8000 --name fba_server fba_backend_independent
    ```
 
@@ -85,7 +85,8 @@ title: Docker 部署
 
    ::: warning
    如果你需要使用 PostgreSQL 数据库，执行命令前，需修改 `.env.server` 部分配置如下：
-   ```env
+   ```env:no-line-numbers
+   # Database
    DATABASE_TYPE='postgresql'
    DATABASE_HOST='fba_postgres'
    DATABASE_PORT=5432
@@ -102,8 +103,8 @@ title: Docker 部署
    services:
      fba_server:
        build:
-         context: ../../../
-         dockerfile: backend/Dockerfile
+         context: .
+         dockerfile: Dockerfile
        image: fba_server:latest
        container_name: fba_server
        restart: always
@@ -247,8 +248,8 @@ title: Docker 部署
    
      fba_celery:
        build:
-         context: ../../../
-         dockerfile: backend/Dockerfile
+         context: .
+         dockerfile: Dockerfile
          args:
            - SERVER_TYPE=celery
        image: fba_celery:latest
@@ -298,7 +299,7 @@ title: Docker 部署
 
    命令执行期间遇到镜像拉取问题请自行 Google
 
-   ```shell
+   ```shell:no-line-numbers
    docker-compose up -d --build
    ```
 
@@ -311,14 +312,13 @@ title: Docker 部署
 
 1. 拉取代码到服务器
 2. env
-
-   :::: details Arco Desgin Vue
+   ::: tabs
+   @tab <Icon name="icon-park-outline:new-lark" />Arco Desgin Vue
    修改 `.env.production` 中的 `VITE_API_BASE_URL` 为域名地址
-   ::::
 
-   :::: details Vben Admin Antd
-   即将到来...
-   ::::
+   @tab <Icon name="devicon:antdesign" />Vben Admin Antd
+   生产中...
+   :::
 
 3. 更新 nginx 配置
 
@@ -461,19 +461,19 @@ title: Docker 部署
 
    创建网络
 
-   ```shell
+   ```shell:no-line-numbers
    docker network create fba_network
    ```
 
    构建
 
-   ```shell
+   ```shell:no-line-numbers
    docker-compose build fba_ui
    ```
 
    启动
 
-   ```shell
+   ```shell:no-line-numbers
    docker-compose run fba_ui
    ```
 
@@ -491,18 +491,18 @@ title: Docker 部署
 
 清理未使用的镜像
 
-```shell
+```shell:no-line-numbers
 docker image prune
 ```
 
 清理未使用的容器
 
-```shell
+```shell:no-line-numbers
 docker container prune
 ```
 
 清理所有未使用的镜像、容器、网络和构建缓存
 
-```shell
+```shell:no-line-numbers
 docker system prune
 ```
diff --git a/docs/guide/mixin/CRUD.md b/docs/guide/mixin/CRUD.md
@@ -37,7 +37,7 @@ class DateTimeMixin(MappedAsDataclass):
 
 [MappedAsDataclass](https://docs.sqlalchemy.org/en/20/orm/dataclasses.html#orm-declarative-native-dataclasses)
 
-声明性数据类基类, 它将带有数据类集成, 允许使用更高级配置；此基类适用于==不包含日期时间的模型==
+声明性数据类基类, 它将带有数据类集成, 允许使用更高级配置；此基类适用于==不包含日期时间的模型=={.warning}
 
 ```python
 class DataClassBase(MappedAsDataclass, MappedBase):
diff --git a/docs/guide/reference/CORS.md b/docs/guide/reference/CORS.md
@@ -15,7 +15,8 @@ CORS_ALLOWED_ORIGINS: list[str] = [
 
 ## 服务器
 
-HTTP 部署
+::: code-tabs
+@tab <Icon name="arcticons:http-custom" />HTTP
 
 ```py
 # [!code word:http]
@@ -24,7 +25,7 @@ CORS_ALLOWED_ORIGINS: list[str] = [
   ]
 ```
 
-HTTPS 部署
+@tab <Icon name="ic:outline-https" /> HTTPS
 
 ```py
 # [!code word:https]
diff --git a/docs/guide/reference/RBAC.md b/docs/guide/reference/RBAC.md
@@ -95,8 +95,8 @@ fba 中默认使用此鉴权方式
     ```
 
 3. 了解策略
-
-   p 策略：
+   ::: tabs
+   @tab p 策略
     - 添加基于角色的访问权限（推荐）
 
       需要配合添加 g 策略才能实现用户访问权限，适合配置所有用户接口访问策略，拥有此角色的用户便能拥有相应的访问权限<br>
@@ -109,10 +109,10 @@ fba 中默认使用此鉴权方式
 
       格式：`用户 uuid + 访问路径 path + 访问方法 method`
 
-   g 策略（基于 p 策略）：
-    - 添加基于角色的访问权限
+   @tab g 策略
+   当 p 策略为【添加基于角色的访问权限】时，需要此策略
 
-      格式：`用户 uuid + 角色 role`
+   格式：`用户 uuid + 角色 role`
 
 4. 添加策略
 
diff --git a/docs/guide/reference/apscheduler.md b/docs/guide/reference/apscheduler.md
@@ -10,6 +10,6 @@ FastAPI + APScheduler 现已作为独立仓库发行，它的优势在于其灵
 <RepoCard repo="fastapi-practices/fastapi_scheduler" />
 
 ::: warning
-此仓库 master 分支使用 APScheduler 4.x 版本进行开发，但由于 aps
-迟迟未发布 4.x 版本，所以请切换 apscheduler-3.x 分支，它是目前比较流行的版本分支，也相对比较稳定
+此仓库 master 分支使用 APScheduler 4.x 版本进行开发，但由于 APScheduler 迟迟未发布 4.x 版本，所以请切换 apscheduler-3.x
+分支，它是目前比较流行的版本分支，也相对比较稳定
 :::
diff --git a/docs/guide/reference/db.md b/docs/guide/reference/db.md
@@ -10,7 +10,7 @@ fba 支持 MySQL、PostgreSQL 两种数据库，默认配置使用 MySQL
 
 如果本地未安装 PostgreSQL，你可以使用以下命令创建 Docker 镜像
 
-```shell
+```shell:no-line-numbers
 docker run -d --name fba_postgres --restart always -e POSTGRES_DB='fba' -e POSTGRES_PASSWORD='123456' -e TZ='Asia/Shanghai' -v fba_postgres:/var/lib/postgresql/data -p 5432:5432 postgres:16
 ```
 
@@ -19,7 +19,7 @@ docker run -d --name fba_postgres --restart always -e POSTGRES_DB='fba' -e POSTG
 PostgreSQL 与 MySQL 在用户名、端口号等方面有所不同，如果你使用上面的命令创建了 Docker 镜像，需修改 `.env` 部分配置如下，否则，请根据
 PostgreSQL 配置进行修改
 
-```env
+```env:no-line-numbers
 # Database
 DATABASE_TYPE='postgresql'
 DATABASE_HOST='127.0.0.1'
diff --git a/docs/guide/reference/response.md b/docs/guide/reference/response.md
@@ -19,15 +19,15 @@ class ResponseModel(BaseModel):
 以下是使用此模型进行返回的示例（遵循 FastAPI 官方教程），`response_model` 参数和 `->` 类型我们只需选择其中一种方式即可，因为
 FastAPI 会在内部自动解析并获取最终响应结构
 
-`response_model` 参数
+`response_model` 参数：
 
 ```python{1,3}
 @router.get('/test', response_model=ResponseModel)
 def test():
     return ResponseModel(data={'test': 'test'})
 ```
 
-`->` 类型
+`->` 类型：
 
 ```python{2,3}
 @router.get('/test')
@@ -51,15 +51,15 @@ class ResponseSchemaModel(ResponseModel, Generic[SchemaT]):
 
 这是我们创建的用于 Schema 模式的统一返回模型，它的用法与 `ResponseModel` 基本相似
 
-`response_model` 参数
+`response_model` 参数：
 
 ```python{1,3}
 @router.get('/test', response_model=ResponseSchemaModel[GetApiDetail])
 def test():
     return ResponseSchemaModel[GetApiDetail](data=GetApiDetail(...))
 ```
 
-`->` 类型
+`->` 类型：
 
 ```python{2,3}
 @router.get('/test')
@@ -98,7 +98,8 @@ def test() -> ResponseSchemaModel[GetApiDetail]:
 它们都是同步方法，而不是异步。因为这些返回方法并不涉及 io 操作，所以，定义为异步，不但没有性能提升，反而增加了异步协程的开销
 :::
 
-`success()`
+::: tabs
+@tab <Icon name="ix:success-filled" />`success()`
 
 此方法通常作为默认响应方法使用，默认返回信息如下
 
@@ -110,19 +111,19 @@ def test() -> ResponseSchemaModel[GetApiDetail]:
 }
 ```
 
-`fail()`
+@tab <Icon name="ix:namur-failure-filled" />`fail()`
 
 此方法通常在接口响应信息为失败时使用，默认返回信息如下
 
 ```json
 {
-  "code": 200,
-  "msg": "请求成功",
+  "code": 400,
+  "msg": "请求错误",
   "data": null
 }
 ```
 
-`fast_success()`
+@tab <Icon name="ix:certificate-success-filled" />`fast_success()`
 
 此方法通常仅用于接口返回大型 json 时，可为 json 解析性能带来质的提升，默认返回信息如下
 
@@ -134,6 +135,8 @@ def test() -> ResponseSchemaModel[GetApiDetail]:
 }
 ```
 
+:::
+
 ## 响应状态码
 
 在文件 `backend/common/response/response_code.py` 中内置了多种定义响应状态码的方式，我们可以根据 `CustomResponseCode` 和
diff --git a/docs/guide/reference/transaction.md b/docs/guide/reference/transaction.md
@@ -47,8 +47,7 @@ async def create(*, obj: CreateIns) -> None:
 
 ## 如何选择？
 
-以上两种方法，我们更推荐第二种；
+以上两种方法，我们更推荐使用 `begin()`，理由如下：
 
-对于 fba 来说，它更加符合架构风格，并且也能减少千篇一律的接口参数（纯作者强迫症）
-
-而对于无需使用自动提交的事务，我们只需将 `begin()` 方法去掉，直接使用 `async_db_session()` 即可
+1. 对于 fba 来说，它更加符合架构风格，并且也能减少千篇一律的接口参数（纯作者强迫症）
+2. 而对于无需使用自动提交的事务，我们只需将 `begin()` 方法去掉，直接使用 `async_db_session()` 即可
diff --git a/docs/guide/summary/quick-start.md b/docs/guide/summary/quick-start.md
diff --git a/docs/planet.md b/docs/planet.md
diff --git a/docs/plugin/dev.md b/docs/plugin/dev.md
diff --git a/docs/plugin/market.md b/docs/plugin/market.md
diff --git a/docs/sponsors.md b/docs/sponsors.md

-Original file line number
+Diff line change
        此方式需要你删除拉取项目后根目录下的 `.git` 文件夹，之后上传到你指定的仓库即可，具体请自行查阅你要上传平台的行为准则
 -       ```shell
 +       ```shell:no-line-numbers
        git clone https://github.com/fastapi-practices/fastapi_best_architecture.git
        ```
 . 安装依赖包
 -   ::: note
 -   fba 内默认使用 pypi 官方源，如果您需要安装依赖加速，可选择 🪜 或 [替换 pypi 国内源](https://github.com/RubyMetric/chsrc)
 -   :::
+-
     - 架构依赖
       拉取项目到本地后，在项目根目录，执行以下命令安装架构依赖
 -      ```shell
 +      ::: code-tabs
 +      @tab <Icon name="material-icon-theme:uv" />uv
 +      ```shell:no-line-numbers
 +      uv sync --frozen
 +      ```
++
 +      @tab <Icon name="material-icon-theme:python" />pip
 +      ```shell:no-line-numbers
       pip install -r requirements.txt
       ```
 +      :::
     - 插件依赖
    在 `backend` 目录中，创建环境变量文件
 -   ```shell
 +   ```shell:no-line-numbers
    touch .env
    ```
    将初始化环境变量配置拷贝到环境变量文件中
 -   ```shell
 +   ```shell:no-line-numbers
    cp .env.example .env
    ```
 . 按需修改配置文件 `backend/core/conf.py` 和 `.env`
 . 创建数据库表（三选一）
 -    - 直接启动后端项目（自动创建）
 -    - 数据库迁移 [alembic](https://alembic.sqlalchemy.org/en/latest/tutorial.html)
+-
 -      生成迁移文件
 +   ::: tabs
 +   @tab 自动创建
 +   直接启动后端项目
 -      ```shell
 -      alembic revision --autogenerate
 -      ```
+-
 -      执行迁移
+-
 -      ```shell
 -      alembic upgrade head
 -      ```
 +   @tab Alembic 迁移
 +   生成迁移文件
 +   ```shell:no-line-numbers
 +   alembic revision --autogenerate
 +   ```
 -    - 执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
 +   执行迁移
 +   ```shell:no-line-numbers
 +   alembic upgrade head
 +   ```
 -9. 启动 celery worker, beat 和 flower ==（可选）==
 +   @tab SQL 脚本
 +   执行 `backend/sql/` 目录下对应数据库的 `create_tables.sql` 脚本
 +   :::
 -   Celery 应用程序
 +9. 启动 celery worker, beat 和 flower <Badge type="warning" text="此步骤为可选" />
 -   ```shell
 +   ::: code-tabs
 +   @tab Worker
 +   ```shell:no-line-numbers
    celery -A app.task.celery worker -l info
    ```
 -   定时任务
+-
 -   ```shell
 +   @tab Beat
 +   ```shell:no-line-numbers
    celery -A app.task.celery beat -l info
    ```
+-
 -   web 监控
+-
 -   ```shell
++
 +   @tab Flower
 +   ```shell:no-line-numbers
    celery -A app.task.celery flower --port=8555 --basic-auth=admin:123456
    ```
 +   :::
++
 . 初始化测试数据
     帮助
 -    ```shell
 +    ```shell:no-line-numbers
     fastapi --help
     ```
     开发模式
 -    ```shell
 +    ```shell:no-line-numbers
     fastapi dev main.py
     ```
 效果演示，它们不一定适用于生产环境，您可以点击查看我们的 [目标](./why.md#目标)
 :::
 -::::: details Arco Desgin Vue
 +::::: tabs
 +@tab <Icon name="icon-park-outline:new-lark" />Arco Desgin Vue
 ::: caution
 这是一个实验性实施，仅用于效果演示，此版本即将存档，请勿将其用于生产！
 . 拉取 Git 项目
 -   ```shell
 +   ```shell:no-line-numbers
    git clone https://github.com/fastapi-practices/fastapi_best_architecture_ui.git
    ```
    进入项目根目录，安装依赖
 -   ```shell
 +   ```shell:no-line-numbers
    yarn install
    ```
    启动
 -   ```shell
 +   ```shell:no-line-numbers
    yarn dev
    ```
 ::::
 -:::::
 -::::: details Vben Admin Antd
 +@tab <Icon name="devicon:antdesign" />Vben Admin Antd
 ::: tip
 这是下一代实施，目前正处于积极开发阶段，未来将完全适配 fba
 :::
 +:::: steps
++
 . 准备本地环境
     * Nodejs 20.10.0+
     * pnpm 9.12.0+
 . 拉取 Git 项目
 -   ```shell
 +   ```shell:no-line-numbers
    git clone https://github.com/fastapi-practices/fba_admin.git
    ```
 . 安装和启动
    进入项目根目录，安装依赖
 -   ```shell
 +   ```shell:no-line-numbers
    pnpm install
    ```
    启动
 -   ```shell
 +   ```shell:no-line-numbers
    pnpm dev
    ```
 +::::
 :::::
 ## 开发流程
 . 初始化测试数据，执行 `backend/sql/` 目录下对应数据库的 `init_test_data.sql` 脚本
 . 在项目根目录，执行单元测试命令
 -   ```shell
 +   ```shell:no-line-numbers
    pytest -vs --disable-warnings
    ```
-Original file line number
+Diff line change
     />
 </CardGrid>
 -### TODO
+-
 -<CardGrid>
 -  <LinkCard
 -    title="空"
 -    icon="fluent-color:receipt-16"
 -    description="..."
 -    />
 -</CardGrid>
+-
 ## 插件
 ::: note
-Original file line number
+Diff line change
 与插件相关的部分文档中，可能高频次出现以下两个词
 -- ==应用级插件=={.note}
+-
 -  在 [项目结构](../guide/summary/intro.md#项目结构) 中，app
 -  目录下的一级文件夹被视为应用，此原理同样应用于插件系统。也就是说，如果插件被开发为应用，那么它们将会像应用一样被注入到系统中，我们称这类插件为【应用级插件】
+-
 -- ==扩展级插件=={.note}
+-
 -  与【应用级插件】相反，如果插件不被开发为应用，那么它们将被开发为 app 目录下已存在应用的扩展功能，并做为扩展 API
 -  被注入应用中，我们称这类插件为【扩展级插件】
 +::: tabs
 +@tab <Icon name="carbon:app" />应用级插件
 +在 [项目结构](../guide/summary/intro.md#项目结构) 中，app
 +目录下的一级文件夹被视为应用，此原理同样应用于插件系统。也就是说，如果插件被开发为应用，那么它们将会像应用一样被注入到系统中，我们称这类插件为【应用级插件】
++
 +@tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
 +与【应用级插件】相反，如果插件不被开发为应用，那么它们将被开发为 app 目录下已存在应用的扩展功能，并做为扩展 API
 +被注入应用中，我们称这类插件为【扩展级插件】
 +:::
 ### 插件目录结构
             - conf.py 常量配置 <Badge type="warning" text="非必须" />
             - plugin.toml 插件配置文件 <Badge type="danger" text="必须" />
             - README.md 插件使用说明 <Badge type="danger" text="必须" />
 -            - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />
 +            - requirements.txt 依赖包文件 <Badge type="warning" text="非必须" />；
               如果插件需要安装依赖，则为 <Badge type="danger" text="必须" />
 :::
 如果插件符合插件开发的要求，则插件中的所有路由都将自动注入到 FastAPI 应用中，无需任何其他操作，但值得注意的是，启动时间可能会随着插件数量的递增而增加，因为
 fba 会在启动前对所有插件进行解析
 -- 应用级插件
+-
 -  插件路由应完全遵循 [路由结构](../guide/reference/router.md#路由结构) 进行定义
 +::: tabs
 +@tab <Icon name="carbon:app" />应用级插件
 +插件路由应完全遵循 [路由结构](../guide/reference/router.md#路由结构) 进行定义
 -- 扩展级插件
+-
 -  插件路由必须根据现有应用中的目录结构进行 1:1 复制，可参考 fba
 -  中的内置插件 [notice](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend/plugin/notice/api)
 +@tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
 +插件路由必须根据现有应用中的目录结构进行 1:1 复制，可参考 fba
 +中的内置插件 [notice](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend/plugin/notice/api)
 +:::
 ### 插件配置
 `plugin.toml` 是插件的配置文件，它必须存在，此配置文件需根据插件的属性进行定义
 -- 应用级插件
+-
 -    ```toml
 -    # 应用配置
 -    [app]
 -    # 插件路由器版本，默认为 v1，可参考源码：backend/app/admin/api/router.py
 -    router = ['v1']
 -    ```
+-
 -- 扩展级插件
+-
 -    ```toml
 -    # 应用配置
 -    [app]
 -    # 此插件属于哪个 app
 -    include = ''
+-
 -    # api 配置
 -    # xxx 对应的是插件 api 目录下的接口文件名（不包含后缀）
 -    # 例如接口文件名为 notice.py，则 xxx 应该为 notice
 -    # 如果包含多个接口文件，则应存在多个相应的 api 配置
 -    [api.xxx]
 -    # 路由前缀，必须以 '/' 开头
 -    prefix = ''
 -    # 标签，用于接口文档
 -    tags = ''
 -    ```
 +::: tabs
 +@tab <Icon name="carbon:app" />应用级插件
++
 +```toml
 +# 应用配置
 +[app]
 +# 插件路由器版本，默认为 v1，可参考源码：backend/app/admin/api/router.py
 +router = ['v1']
 +```
++
 +@tab <Icon name="fluent:table-simple-include-16-regular" />扩展级插件
++
 +```toml
 +# 应用配置
 +[app]
 +# 此插件属于哪个 app
 +include = ''
++
 +# api 配置
 +# xxx 对应的是插件 api 目录下的接口文件名（不包含后缀）
 +# 例如接口文件名为 notice.py，则 xxx 应该为 notice
 +# 如果包含多个接口文件，则应存在多个相应的 api 配置
 +[api.xxx]
 +# 路由前缀，必须以 '/' 开头
 +prefix = ''
 +# 标签，用于接口文档
 +tags = ''
 +```
++
 +:::
 ## 前端
-Original file line number
+Diff line change
 - <Badge type="info" text="free" /> - 免费插件
 - <Badge type="danger" text="pay" /> - 付费插件
 - <Badge type="tip" text="fba" /> - 仅后端代码插件
 -- <Badge text="fba + vben" color="#c178ec"/> - 包含前端 [fba_admin](https://github.com/fastapi-practices/fba_admin) 代码插件
 +- <Badge text="fba + vben" color="#c178ec"/> - 包含前端 [fba_admin](https://github.com/fastapi-practices/fba_admin) 代码插件 <Badge type="warning" text="暂无此计划" />
 - <Badge text="app" color="#ff9900"/> - 应用级插件
 - <Badge text="extra" color="#11aa00"/> - 扩展级插件
 这些插件由社区中的开发者提供和维护
 <CardGrid>
 -  <Card title="空空如也">
 +  <Card title="空">
   </Card>
 </CardGrid>
 ## 安装
 -插件安装方式可分为两种
 +插件安装方式包含两种
 -### 手动
 +::: tabs
 +@tab 1. 手动
 . 获取插件仓库源码并下载，将源码中的插件目录直接拷贝到 fba 项目对应的目录下
 . 如果插件包含依赖，执行 `backend/scripts/init_plugin.py` 文件安装依赖
 . 根据插件使用说明完成安装
 -### 自动
 +@tab 2. 自动
 . 获取打包好的插件 zip 压缩包
 . 将压缩包通过插件安装接口进行安装
 . 根据插件使用说明完成安装
++
 +:::
-Original file line number
+Diff line change
 您可以加入我们创建的 [知识星球](https://t.zsxq.com/PDk8b)，获取星球内提供的独家内容，另外，我们会为您添加 Discord
 身份标签，以便将您加入专属频道，针对标签用户，我们还可以提供一对一线上指导，远程支持等...
 -请注意，我们不保证星球内容的更新频率，==您可以依据星球规则进行全额退款==，我们鼓励大家[参与贡献](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#readme)
 +请注意，我们不保证星球内容的更新频率，==您可以依据星球规则进行全额退款=={.warning}，我们鼓励大家 [参与贡献](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend#readme)
 ，如果您能为 Issues 提供 PR，并且被审核通过，我们将向您发送大额优惠券或免费邀请（基于 PR 质量）
 ## 展位赞助商
 :::
 ::: warning 展位赞助说明
 -选择==特别展位==赞助，可帮助您的产品在 Discord 交流群以公告的形式进行推广一次
 +选择【特别展位】赞助，可帮助您的产品在 Discord 交流群以公告的形式进行推广一次
 - 优先推广和程序员相关的互联网产品，比如：低代码开发平台、网课、开发软件、云服务器、个人博客等等，实体产品如键盘、显示器、耳机等等，如果是和程序员无关的产品，可酌情考虑是否推广
 - 拒绝接受违反法律法规、以及灰色相关的产品推广（GPT相关不包含在内）