mirror of
https://github.com/fastapi-practices/fastapi-best-architecture.git
synced 2026-09-21 21:15:13 +00:00
Update plugin README content format (#1158)
* Update plugin README content format * Fix lint
This commit is contained in:
Wu Clan
@@ -2,13 +2,22 @@
|
||||
|
||||
代码生成器插件，生成通用业务代码
|
||||
|
||||
> [!TIP]
|
||||
> 当前版本仅包含后端代码生成
|
||||
- 支持维护代码生成业务配置与模型列信息
|
||||
- 支持手动模式和自动导表模式生成通用业务代码
|
||||
- 支持预览、写入磁盘和下载生成结果
|
||||
|
||||
> [!WARNING]
|
||||
> 由于 jinja2 在渲染模版时，文本方式输出可能存在格式问题，所以 `preview` 接口可能无法直观预览代码，这是为前端进行的预设
|
||||
## 插件类型
|
||||
|
||||
## 全局配置
|
||||
- 应用级插件
|
||||
|
||||
## 配置说明
|
||||
|
||||
插件目录下 `plugin.toml` 的 `[settings]` 中包含以下内容：
|
||||
|
||||
```toml
|
||||
[settings]
|
||||
CODE_GENERATOR_DOWNLOAD_ZIP_FILENAME = 'fba_generator'
|
||||
```
|
||||
|
||||
在 `backend/core/conf.py` 中添加以下内容：
|
||||
|
||||
@@ -16,38 +25,22 @@
|
||||
##################################################
|
||||
# [ Plugin ] code_generator
|
||||
##################################################
|
||||
# 基础配置（in plugin.toml）
|
||||
CODE_GENERATOR_DOWNLOAD_ZIP_FILENAME: str
|
||||
```
|
||||
|
||||
## 简介
|
||||
|
||||
代码生成器使用 API 调用实现，包含两个模组，设计可能存在缺陷，相关问题请直接提交 issues
|
||||
|
||||
### 代码生成业务
|
||||
|
||||
包含代码生成的相关配置，详情查看：`code_generator/model/gen_business.py`
|
||||
|
||||
### 代码生成模型列
|
||||
|
||||
包含代码生成所需要的模型列信息，就像正常定义模型列一样，目前支持的功能有限
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 启动后端服务，打开 swagger 文档直接操作
|
||||
2. 通过第三方 api 调试工具发送接口请求
|
||||
3. 同时启动前后端，从页面进行操作
|
||||
1. 安装并启用插件后，重启后端服务
|
||||
2. 维护业务配置和模型列信息
|
||||
3. 执行预览、生成和下载流程
|
||||
4. 生成代码会直接写入磁盘，仅必须在开发环境使用
|
||||
|
||||
接口参数基本都有说明，请注意查看
|
||||
## 卸载说明
|
||||
|
||||
### 手动模式
|
||||
- 卸载插件后，建议同步移除相关插件基础配置和 `backend/core/conf.py` 中的插件配置
|
||||
- 如项目中已接入代码生成相关页面或自动化流程，请同步清理对应集成
|
||||
|
||||
1. 通过创建业务接口手动添加一项业务数据
|
||||
2. 通过模型创建接口手动添加模型列
|
||||
3. 访问 `preview`（预览），`generate`（磁盘写入），`download`（下载）接口，执行后端代码生成相应工作
|
||||
## 联系方式
|
||||
|
||||
### 自动模式
|
||||
|
||||
1. 访问 `tables` 接口，获取数据库表名列表
|
||||
2. 通过 `import` 接口，导入数据库已有的数据库表数据，将自动创建业务表数据和模型表数据
|
||||
3. 访问 `preview`（预览），`generate`（磁盘写入），`download`（下载）接口，执行后端代码生成相应工作
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
@@ -1,3 +1,30 @@
|
||||
# Config
|
||||
|
||||
参数配置插件，通常用于动态配置系统参数和前端工程数据展示
|
||||
参数配置插件，通常用于动态维护系统参数和前端工程展示所需的配置数据
|
||||
|
||||
- 支持维护系统参数配置
|
||||
- 适合前端工程展示数据和系统级动态参数场景
|
||||
|
||||
## 插件类型
|
||||
|
||||
- 扩展级插件
|
||||
- 扩展目标：`admin`
|
||||
|
||||
## 配置说明
|
||||
|
||||
当前插件无需额外配置
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 安装并启用插件后，重启后端服务
|
||||
2. 通过系统后台页面或 Swagger 管理参数配置数据
|
||||
|
||||
## 卸载说明
|
||||
|
||||
- 卸载插件后无需额外清理环境变量或插件配置
|
||||
- 如业务代码或前端页面已依赖参数配置能力，请同步清理对应集成
|
||||
|
||||
## 联系方式
|
||||
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
@@ -1,3 +1,31 @@
|
||||
# Dict
|
||||
|
||||
数据字典插件，通常用于约束前端工程数据展示
|
||||
数据字典插件，通常用于维护字典类型、字典数据，并约束前端工程中的枚举展示与选项映射
|
||||
|
||||
- 支持维护字典类型和字典数据
|
||||
- 适合前端状态值、分类值、下拉选项等统一字典场景
|
||||
|
||||
## 插件类型
|
||||
|
||||
- 扩展级插件
|
||||
- 扩展目标：`admin`
|
||||
|
||||
## 配置说明
|
||||
|
||||
当前插件无需额外配置
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 安装并启用插件后，重启后端服务
|
||||
2. 先维护字典类型，再维护对应的字典数据
|
||||
3. 使用稳定的字典编码维护前端枚举与选项映射
|
||||
|
||||
## 卸载说明
|
||||
|
||||
- 卸载插件后无需额外清理环境变量或插件配置
|
||||
- 如前端或业务代码已依赖字典能力与字典编码，请同步清理对应集成
|
||||
|
||||
## 联系方式
|
||||
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
@@ -2,7 +2,34 @@
|
||||
|
||||
电子邮件插件，提供邮件发送功能，支持验证码、通知等场景
|
||||
|
||||
## 全局配置
|
||||
- 支持 SMTP 邮件发送
|
||||
- 支持验证码、通知等邮件场景
|
||||
- 支持按基础配置控制邮箱服务、验证码有效期和 Redis 前缀
|
||||
|
||||
## 插件类型
|
||||
|
||||
- 应用级插件
|
||||
|
||||
## 配置说明
|
||||
|
||||
在 `backend/.env` 中添加以下内容：
|
||||
|
||||
```env
|
||||
# [ Plugin ] email
|
||||
EMAIL_USERNAME=''
|
||||
EMAIL_PASSWORD=''
|
||||
```
|
||||
|
||||
插件目录下 `plugin.toml` 的 `[settings]` 中包含以下内容：
|
||||
|
||||
```toml
|
||||
[settings]
|
||||
EMAIL_CAPTCHA_EXPIRE_SECONDS = 180
|
||||
EMAIL_CAPTCHA_REDIS_PREFIX = 'fba:email:captcha'
|
||||
EMAIL_HOST = 'smtp.qq.com'
|
||||
EMAIL_PORT = 465
|
||||
EMAIL_SSL = true
|
||||
```
|
||||
|
||||
在 `backend/core/conf.py` 中添加以下内容：
|
||||
|
||||
@@ -21,3 +48,19 @@ EMAIL_SSL: bool
|
||||
EMAIL_CAPTCHA_REDIS_PREFIX: str
|
||||
EMAIL_CAPTCHA_EXPIRE_SECONDS: int
|
||||
```
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 安装并启用插件后，配置正确的 SMTP 账号与密码
|
||||
2. 根据实际邮箱服务商修改 `EMAIL_HOST`、`EMAIL_PORT`、`EMAIL_SSL`
|
||||
3. 重启后端服务后，通过系统页面、Swagger 或业务代码使用邮件能力
|
||||
|
||||
## 卸载说明
|
||||
|
||||
- 卸载插件后，建议同步移除相关环境变量、插件基础配置和 `backend/core/conf.py` 中的插件配置
|
||||
- 如业务代码仍在使用邮件发送能力，请同步清理对应集成
|
||||
|
||||
## 联系方式
|
||||
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
@@ -1,3 +1,30 @@
|
||||
# Notice
|
||||
|
||||
通知公告插件，用于发布系统内部通知、公告
|
||||
|
||||
- 支持维护系统通知和公告内容
|
||||
- 适合后台公告、站内通知等场景
|
||||
|
||||
## 插件类型
|
||||
|
||||
- 扩展级插件
|
||||
- 扩展目标：`admin`
|
||||
|
||||
## 配置说明
|
||||
|
||||
当前插件无需额外配置
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 安装并启用插件后，重启后端服务
|
||||
2. 通过后台页面或 Swagger 维护通知公告内容
|
||||
|
||||
## 卸载说明
|
||||
|
||||
- 卸载插件后无需额外清理环境变量或插件配置
|
||||
- 如前端页面或业务逻辑已依赖通知公告能力，请同步清理对应集成
|
||||
|
||||
## 联系方式
|
||||
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
@@ -2,7 +2,37 @@
|
||||
|
||||
OAuth 2.0 第三方登录插件，支持 GitHub、Google 等社交平台登录
|
||||
|
||||
## 全局配置
|
||||
- 支持 GitHub、Google 第三方登录
|
||||
- 支持第三方账号绑定与解绑
|
||||
- 支持登录回跳和绑定回跳配置
|
||||
|
||||
## 插件类型
|
||||
|
||||
- 应用级插件
|
||||
|
||||
## 配置说明
|
||||
|
||||
在 `backend/.env` 中添加以下内容：
|
||||
|
||||
```env
|
||||
# [ Plugin ] oauth2
|
||||
OAUTH2_GITHUB_CLIENT_ID='test'
|
||||
OAUTH2_GITHUB_CLIENT_SECRET='test'
|
||||
OAUTH2_GOOGLE_CLIENT_ID='test'
|
||||
OAUTH2_GOOGLE_CLIENT_SECRET='test'
|
||||
```
|
||||
|
||||
插件目录下 `plugin.toml` 的 `[settings]` 中包含以下内容：
|
||||
|
||||
```toml
|
||||
[settings]
|
||||
OAUTH2_FRONTEND_BINDING_REDIRECT_URI = 'http://localhost:5173/profile'
|
||||
OAUTH2_FRONTEND_LOGIN_REDIRECT_URI = 'http://localhost:5173/oauth2/callback'
|
||||
OAUTH2_GITHUB_REDIRECT_URI = 'http://127.0.0.1:8000/api/v1/oauth2/github/callback'
|
||||
OAUTH2_GOOGLE_REDIRECT_URI = 'http://127.0.0.1:8000/api/v1/oauth2/google/callback'
|
||||
OAUTH2_STATE_EXPIRE_SECONDS = 180
|
||||
OAUTH2_STATE_REDIS_PREFIX = 'fba:oauth2:state'
|
||||
```
|
||||
|
||||
在 `backend/core/conf.py` 中添加以下内容：
|
||||
|
||||
@@ -24,3 +54,21 @@ OAUTH2_GOOGLE_REDIRECT_URI: str
|
||||
OAUTH2_FRONTEND_LOGIN_REDIRECT_URI: str
|
||||
OAUTH2_FRONTEND_BINDING_REDIRECT_URI: str
|
||||
```
|
||||
|
||||
## 使用方式
|
||||
|
||||
1. 安装并启用插件后，在 GitHub、Google 开放平台分别创建 OAuth 应用
|
||||
2. 将平台分配的 Client ID、Client Secret 配置到项目环境变量中
|
||||
3. 确保平台回调地址与 `OAUTH2_GITHUB_REDIRECT_URI`、`OAUTH2_GOOGLE_REDIRECT_URI` 保持一致
|
||||
4. 配置前端登录回跳地址与绑定回跳地址
|
||||
5. 重启后端服务后，使用第三方登录、绑定和解绑能力
|
||||
|
||||
## 卸载说明
|
||||
|
||||
- 卸载插件后，建议同步移除相关环境变量、插件基础配置和 `backend/core/conf.py` 中的插件配置
|
||||
- 如前端登录页或个人中心已集成第三方登录、绑定等能力，请同步清理对应集成
|
||||
|
||||
## 联系方式
|
||||
|
||||
- 作者：`wu-clan`
|
||||
- 反馈方式：提交 Issue 或 PR
|
||||
|
||||
Reference in New Issue
Block a user