插件规范
通用规范
- 插件内不可包含存在侵权的图标、字体、代码、文字、图片、图片中的文字、样式或素材等
- 插件必须能在
后台管理->插件管理正常离线安装 - 插件内请勿附带任何推广文字或链接
- 插件内不能包含插件内
子市场(远程下载模块)功能 - 插件内不能包含加密的代码
- 插件内必须包含完整的代码,不能提供额外链接用于下载其它资源
- 插件内代码不能引入其它远程iframe页面
- 插件非辅助类别插件功能不能过于单一
- 插件必须提供完整的功能介绍、截图和文档
- 插件内服务端代码必须基于PSR-2规范进行编码和格式化
- 插件目录、插件标识、数据库前缀、菜单规则标识等必须一一匹配
- 插件目录
控制器、模型、类、视图等如有多个时必须使用层级,且层级的顶层目录必须为插件标识 - 插件安装时不能覆盖修改FastAdmin框架的核心文件和核心数据表结构
- 插件目录不能包含任何隐藏脚本文件
public目录下不允许任何的php/asp/jsp等服务端脚本文件- 插件内API接口图片和资源必须使用
cdnurl("地址", true);进行补全URL前缀 - 插件内如有使用自定义函数,请务必在自定义函数前加
插件标识_或使用命名空间进行自定义函数 - API接口遵循最小数据返回,API在读取数据库数据并返回时,遵循最小数据返回,只返回客户端当前请求所需要的数据,而不是返回多余或冗余的信息
- 插件内不允许使用或包含AI生成的图片、文本、音频等资源
- 引用第三方资源或依赖包时,是否做好版权标识或链接、License文件存储
- 插件含有UGC内容时,必须有后台审核或API内容安全审核,如果是小程序可接入微信官方内容安全审核接口
插件依赖规范
我们在开发FastAdmin应用插件中如果需要依赖到插件市场的插件时,需要注意以下依赖规范:
- 如有必选依赖插件时,必须包含一款免费插件,确保基础功能可用,例如
(编辑器、短信发送)。 - 如有可选依赖插件时,应用插件可以是收费的,但插件在没有安装这些可选依赖插件时,必须能够正常运行,以保证插件的灵活性和兼容性。
- 在开发自己的插件时,要尽量确保插件在没有安装可选依赖插件的情况下仍能正常运行,以提供更好的用户体验。
版本号规范
我们在开发FastAdmin应用插件时需做好版本号的更新和维护。
版本格式:主版本号.次版本号.修订号
版本号递增规则
1.主版本号:当你做了不兼容的 API 修改。
2.次版本号:当你做了向下兼容的功能性新增。
3.修订号:当你做了向下兼容的问题修正。
具体语义化规范请参考:https://semver.org/lang/zh-CN/
命名规范
具体命名规范可以参考:https://www.kancloud.cn/manual/thinkphp5/118007
文档最后更新时间:2025-11-18 15:17:08
著作权归应用插件开发者所有,未经许可,禁止转载、复制此文档的任何内容。
未解决你的问题?请到「问答社区」反馈你遇到的问题