update docs

wu-clan · wu-clan · commit bd1eb9735481 · 2025-02-14T13:02:16.000+08:00
diff --git a/docs/.vuepress/navbar.ts b/docs/.vuepress/navbar.ts
@@ -2,15 +2,31 @@ import {defineNavbarConfig} from "vuepress-theme-plume";
 
 export const myNavbar = defineNavbarConfig([
     {
-        text: 'UI 演示',
-        items: [
+        text: 'UI 效果',
+        items:[
             {
-                text: 'Arco Design Vue 实验性实施',
-                link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
+                text: 'Git 仓库',
+                icon: 'mdi:git',
+                items: [
+                    {
+                        text: 'Arco Design Vue 实验性实施',
+                        link: 'https://github.com/fastapi-practices/fastapi_best_architecture_ui'
+                    },
+                    {
+                        text: 'Vben Admin Antd 下一代实施',
+                        link: 'https://github.com/fastapi-practices/fba_ui'
+                    }
+                ]
             },
             {
-                text: 'Vben Admin Antd 下一代实施',
-                link: 'https://github.com/fastapi-practices/fba_ui'
+                text: '线上演示',
+                icon: 'mdi:web',
+                items: [
+                    {
+                        text: 'Arco Design Vue 实验性实施',
+                        link: 'https://fba.wu-clan.site/'
+                    }
+                ]
             }
         ]
     },
@@ -40,12 +56,12 @@ export const myNavbar = defineNavbarConfig([
         ]
     },
     {
-        text: '插件',
+        text: '插件市场',
         icon: 'clarity:plugin-solid',
         link: '/plugin/before'
     },
     {
-        text: '授权',
+        text: '购买授权',
         icon: 'fluent:person-key-20-filled',
         link: '/guide/summary/why.md#承诺'
     },
diff --git a/docs/.vuepress/sidebar.ts b/docs/.vuepress/sidebar.ts
@@ -19,7 +19,7 @@ export const mySidebar: SidebarMulti = {
             collapsed: false,
             prefix: 'reference/',
             items: [
-                {text: '路由', link: 'route'},
+                {text: '路由', link: 'router'},
                 {text: 'JWT', link: 'jwt'},
                 {text: 'CRUD', link: 'CRUD'},
                 {text: '接口响应', link: 'response'},
@@ -71,6 +71,7 @@ export const mySidebar: SidebarMulti = {
             items: [
                 {text: '前言', link: 'before'},
                 {text: '插件开发', link: 'dev'},
+                {text: '插件发布', link: 'publish'},
                 {text: '插件市场', link: 'market'},
             ]
         }
diff --git a/docs/guide/reference/router.md b/docs/guide/reference/router.md
@@ -12,35 +12,33 @@ FBA 中的路由遵循 Restful API 规范
 
 ::: file-tree
 
-- backend/ 后端
-    - app/ 应用
-        - xxx 某自定义应用
+- backend 后端
+    - app 应用
+        - xxx 自定义应用（包含子包）
             - api 接口
-                - v1 包含子包
+                - v1
                     - xxx 子包
-                        - __init\_\_.py 在此文件内导入 xxx.py 中的路由器
+                        - __init\_\_.py 在此文件内注册子包内 xxx.py 文件中的路由
                         - xxx.py
                         - ...
-                    - ...
-                - v2/
-                - ...
                 - __init\_\_.py
-                - router.py 在此文件内注册所有子包 __init\_\_.py 中的路由
-        - xxx 某自定义应用
+                - router.py 在此文件内注册所有子包 __init\_\_.py 文件中的路由
+        - xxx 自定义应用（不包含子包）
             - api 接口
-                - v1 不包含子包
+                - v1
                     - _\_init\_\_.py 不做任何操作
                     - xxx.py
-                - ...
+                    - ...
                 - __init\_\_.py
-                - router.py 在此文件内注册所有 xxx.py 中的路由
+                - router.py 在此文件内注册所有 xxx.py 文件中的路由
     - __init\_\_.py
-    - router.py 在此文件内注册所有 app router.py 中的路由
+    - router.py 在此文件内注册所有 app 目录下 router.py 文件中的路由
 
 :::
 
 ::: warning
-我们统一命名了所有接口路由参数为 router，这很有助于我们编写接口，但是，不可忽略的是，在注册路由时，一定要注意我们的导入方式，在
-FBA 中，我们可以查看所有路由的导入，它们看起来像 `from backend.app.admin.api.v1.sys.api import router as api_router`
+我们统一命名了所有接口路由参数为 router，这很有助于我们编写接口，但是，不可忽略的是，在注册路由时，一定要注意我们的导入方式
+
+在 FBA 中，我们可以查看所有路由的导入，它们看起来像 `from backend.app.admin.api.v1.sys.api import router as api_router`
 ，我们这里务必导入文件内的路由参数 `router`，为了避免参数名称冲突，我们可以使用 `as` 为路由参数起一个别名
 :::
diff --git a/docs/guide/summary/intro.md b/docs/guide/summary/intro.md
@@ -46,19 +46,21 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
 - [x] 角色管理：角色菜单权限分配，角色路由权限分配
 - [x] 字典管理：维护系统内部常用固定数据或参数
 - [x] 令牌管理：系统用户在线状态检测，支持踢人下线
+- [x] 登录认证：基于后端的图形验证码后台认证登录
+- [x] 多点登录：通过用户信息一键修改多点登录支持
 - [x] 代码生成：后端代码自动生成，支持预览，写入及下载
+- [x] 定时任务：自动化任务，异步任务，支持函数调用
+- [x] 插件系统：通过热插拔插件模式告别高耦合集成
 - [x] 操作日志：系统正常和异常操作的日志记录与查询
-- [x] 登录认证：图形验证码后台认证登录
 - [x] 登录日志：用户正常和异常登录的日志记录与查询
 - [x] 服务监控：服务器硬件设备信息与状态
-- [x] 定时任务：自动化任务，异步任务，支持函数调用
-- [x] 接口文档：自动生成在线交互式 API 接口文档
+- [x] 接口文档：自动生成在线交互式 API 文档
 
 ## 项目结构
 
 ::: file-tree
 
-- backend/ 后端
+- backend 后端
     - alembic/ 数据库迁移
     - app/ 应用
         - admin 系统后台
@@ -76,6 +78,7 @@ mvc 架构作为常规设计模式，在 python web 中很常见，但是三层
     - database/ 数据库连接
     - log/ 日志
     - middleware/ 中间件
+    - plugin/ 插件
     - scripts/ 脚本
     - sql/ SQL文件
     - static/ 静态文件
diff --git a/docs/guide/summary/quick-start.md b/docs/guide/summary/quick-start.md
@@ -230,8 +230,11 @@ title: 快速开始
 ::: steps
 
 1. 定义数据库模型（model）
+
 2. 定义数据验证模型（schema）
+
 3. 定义视图（api）和路由（router）
+
 4. 编写业务（service）
 
 5. 编写数据库操作（crud）
diff --git a/docs/plugin/before.md b/docs/plugin/before.md
@@ -30,9 +30,7 @@ title: 前言
 
 ## 技术支持
 
-插件作者需提供至少一种联系方式且必须加入 Discord 社区，我们会在社区内为每个插件提供独立互动频道
-
-第三方插件用户需自行联系第三方插件作者，我们不提供任何第三方插件技术支持
+我们会在社区内为每个插件提供独立互动频道，第三方插件用户需自行联系第三方插件作者，我们不提供任何第三方插件技术支持
 
 ## 免责声明
 
diff --git a/docs/plugin/dev.md b/docs/plugin/dev.md
@@ -2,4 +2,59 @@
 title: 插件开发
 ---
 
-即将到来...
+::: warning
+当前插件开发要求于 2025-02-14 进行定义，一旦修改，我们会立即同步此文档
+:::
+
+## 后端
+
+我们创建了一个插件模板仓库 [fba_plugin_template](https://github.com/fastapi-practices/fba_plugin_template)
+用于插件开发，开发步骤参考如下：
+
+:::: steps
+
+1. clone 最新 fba 项目到本地并配置好开发环境
+2. 根据插件模板的目录结构进行插件开发
+3. 完成插件开发
+4. 使用插件模板仓库创建个人仓库，并将插件代码更新至个人仓库
+
+   ::: note
+   我们鼓励大家将插件源码进行开源，但并不强制，如果您的插件需要付费，则无需上传源码，但必须保留个人仓库，并添加相关付费说明
+   :::
+
+5. [申请发布插件](publish.md)
+
+::::
+
+### 插件目录结构说明
+
+::: file-tree
+
+- backend fba 目录
+    - plugin fba 目录
+        - xxx 插件名
+            - api/ 接口，务必查看下方【插件接口附加说明】
+            - crud/ CRUD
+            - model/ 模型
+            - schema/ 数据传输
+            - service/ 服务
+            - \_\_init__.py 作为 python 包保留（必填项）
+            - conf.py 配置，如果插件不需要独立配置，则无需此文件
+            - plugin.toml 插件配置（必填项）
+            - README.md 插件使用说明，如果插件可直接使用，则无需此文件
+            - requirements.txt 依赖包文件，如果插件不需要安装额外依赖，则无需此文件
+
+:::
+
+::: warning 插件接口附加说明
+
+- 如果插件作为独立 app 发布（在 `backend/app` 目录下的应用，视为独立
+  app），则插件路由应完全遵循 [路由结构](../guide/reference/router.md#路由结构) 进行定义
+- 如果插件作为现有 app 扩展功能发布，则插件路由应当根据现有 app 中的路由结构进行 1:1 结构复制，可参考 fba
+  源码中的内置插件 [notice](https://github.com/fastapi-practices/fastapi_best_architecture/tree/master/backend/plugin/notice/api)
+
+:::
+
+## 前端
+
+一旦 [Vben Admin Antd 下一代实施](https://github.com/fastapi-practices/fba_ui) 生产可用，我们将开启此计划...
diff --git a/docs/plugin/market.md b/docs/plugin/market.md
@@ -8,20 +8,15 @@ title: 插件市场
 :::
 
 ::: info
-你可以在 [插件互动频道](https://discord.gg/5SDAZgDya9) 与插件作者及社区人员进行互动和交流
-:::
-
-> [!IMPORTANT]
-> 插件需要人工审核，请 [点击此处](https://discord.com/channels/1185035164577972344/1332032404663046204)
-> 与我们联系，一旦插件审核通过，我们会立即更新至此页面
+您可以在 [插件互动频道](https://discord.gg/5SDAZgDya9) 与插件作者及社区人员进行互动和交流
 
-## 插件标签
+- <Badge type="info" text="free" /> - 免费插件
+- <Badge type="danger" text="pay" /> - 付费插件
+- <Badge type="tip" text="fba" /> - 仅后端代码插件
+- <Badge text="fba-arco" color="#4582ff"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui) 代码插件
+- <Badge text="fba-vben" color="#c178ec"/> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui) 代码插件
 
-- <Badge type="info" text="free" /> - 免费
-- <Badge type="danger" text="pay" /> - 付费
-- <Badge type="tip" text="fba" /> - 仅后端
-- <Badge text="fba-arco" color="#4582ff"/> - 包含前端 [fastapi_best_architecture_ui](https://github.com/fastapi-practices/fastapi_best_architecture_ui)
-- <Badge text="fba-vben" color="#c178ec"/> - 包含前端 [fba_ui](https://github.com/fastapi-practices/fba_ui)
+:::
 
 ## 官方
 
diff --git a/docs/plugin/publish.md b/docs/plugin/publish.md
@@ -0,0 +1,20 @@
+---
+title: 发布
+---
+
+> [!IMPORTANT]
+> 插件作者需符合以下几点要求
+>
+> - 必须加入 Discord 社区
+> - 必须提供插件仓库 github 地址
+> - 必须在插件仓库 README 文件内提供至少一种（任意）联系方式
+
+::: warning
+插件需要人工审核，请 [点击此处](https://discord.com/channels/1185035164577972344/1332032404663046204)
+与我们联系，付费插件同样需要人工审核，审核通过后，我们承诺会立即销毁本地插件源码
+:::
+
+::: tip
+一旦插件审核通过，我们会立即将插件更新至 [插件市场](market.md) 并在 Discord 社区内创建插件相应的独立互动频道，
+并赋予插件作者相应频道的身份牌和管理权限，对于创建插件数量 >= 2 的插件作者，我们将提供知识星球永久免费入驻名额
+:::
