插件开发
约 1015 字大约 3 分钟
后端
插件分类
应用级插件
在 项目结构 中，app 目录下的一级文件夹被视为应用，此原理同样应用于插件系统。也就是说，如果插件被开发为应用，那么它们将会像应用一样被注入到系统中，我们称这类插件为【应用级插件】
扩展级插件
与【应用级插件】相反，如果插件不被开发为应用，那么它们将被开发为 app 目录下已存在应用的扩展功能，我们称这类插件为【扩展级插件】
插件路由结构
如果插件符合插件开发的要求，则插件中的所有路由都将自动注入到 FastAPI 应用中。但值得注意的是，启动时间可能会随着插件数量的递增而增加，因为 fba 会在启动前对所有插件进行解析
插件配置
plugin.toml 是插件的配置文件，每个插件都必须包含此文件
警告
此配置文件自 fba v1.3.0 版本起发生重大变更，仅向后兼容（低于此版本开发的插件将不可用）
应用级插件
# 插件信息
[plugin]
# 摘要（简短描述）
summary = ''
# 插件版本号
version = ''
# 插件描述
description = ''
# 插件作者
author = ''
# 应用配置
[app]
# 插件路由器实例，可参考源码：backend/app/admin/api/router.py，通常默认命名为 v1
router = ['']扩展级插件
# 插件信息
[plugin]
# 摘要（简短描述）
summary = ''
# 插件版本号
version = ''
# 插件描述
description = ''
# 插件作者
author = ''
# 应用配置
[app]
# 此插件属于哪个 app
include = ''
# 接口配置
# xxx 对应的是插件 api 目录下的接口文件名（不包含后缀）
# 例如接口文件名为 notice.py，则 xxx 应该为 notice
# 如果包含多个接口文件，则应存在多个相应的 api 配置
[api.xxx]
# xxx 路由前缀，必须以 '/' 开头
prefix = ''
# 标签，用于 FastAPI 接口文档
tags = ''数据库兼容性
fba 内所有官方实现都同时兼容 mysql 和 postgresql，但我们不对第三方插件进行强制要求，如果您对此感兴趣，请查看 SQLAlchemy 2.0 官方文档: with_variant
插件目录结构
插件统一放置在 backend/plugin 目录下，以下是插件的目录结构
xxx插件名 必须
api接口 必须
…
crudCRUD 非必须
…
model模型 非必须
__init__.py在此文件内导入所有模型类 必须
…
schema数据传输 非必须
…
service服务 非必须
…
utils工具包 非必须
…
__init__.py作为 python 包保留 必须
…更多内容，例如 enums.py... 非必须
plugin.toml插件配置文件 必须
README.md插件使用说明和您的联系方式 必须
requirements.txt依赖包文件 非必须
前端
注意
暂无此计划...