插件规范

通用规范

TZkKigYbflvaUSIqbDWcqJXQvaK7ILYJq9UsbQ==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  1. 插件内不可包含存在侵权的图标、字体、代码、文字、图片、图片中的文字、样式或素材等
  2. WIctQSgvuLnZEMrjSKCRk0oDoCwt2t7gwlmiww==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  3. 插件必须能在后台管理->插件管理正常离线安装
  4. LmlGwOcRfkirYUgXuBLC1VLliyKB4FExyD89XA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  5. 插件内请勿附带任何推广文字或链接
  6. NhvIPcLOzBUbjoYdEaD8FDmZ6bsyX/qmRjHdIw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  7. 插件内不能包含插件内子市场(远程下载模块)功能
  8. EpwxNuJozYbUjeBTFYhbnCxVk18dNRToYlIbvw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  9. 插件内不能包含加密的代码
  10. fFYSzxWcrJvkBKowm33Zh0UgbRFAKIWrVCrCSg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  11. 插件内必须包含完整的代码,不能提供额外链接用于下载其它资源
  12. ylhRQBsbaEYPnrNxRx1rM4jUH25BrRhqQCpshg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  13. 插件内代码不能引入其它远程iframe页面
  14. shDHzgOPfRjmuQTI9DAL+N2tM2Im8ggM4ahqAg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  15. 插件非辅助类别插件功能不能过于单一
  16. EKuHFabXjTlNMqrSudhpho179flXhF5aX7x+NA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  17. 插件必须提供完整的功能介绍、截图和文档
  18. LKNdBUzfjAmsnaMcuEQFXjinj4pw4+81m7Qzsw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  19. 插件内服务端代码必须基于PSR-2规范进行编码和格式化
  20. eKvsZtoqbfhFrzpjUvjd+jcnOKAnNc0fvp5UZw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  21. 插件目录、插件标识、数据库前缀、菜单规则标识等必须一一匹配
  22. XIgNPpQaWejGHFODNiZtmdGDbtGRLEnhvDOCMA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  23. 插件目录控制器模型视图等如有多个时必须使用层级,且层级的顶层目录必须为插件标识
  24. hrflFxMkEzsZWYtpHV5PI+5VkdWpqI8bgVqvMw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  25. 插件安装时不能覆盖修改FastAdmin框架的核心文件和核心数据表结构
  26. zVXZqJpTihEvCbckkocc5lBG6gYkShVf4V7ylA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  27. 插件目录不能包含任何隐藏脚本文件
  28. zqJMFniGgCUrLfmQKJorNvM0GZpPLzwdfvG6Zg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  29. public目录下不允许任何的php/asp/jsp等服务端脚本文件
  30. IQkfNXTSnrBZGwpMbkzrOyJEh/ShoQFPZ3KmHw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  31. 插件内API接口图片和资源必须使用cdnurl("地址", true);进行补全URL前缀
  32. ThMlXDzvkJpfardFGnZKfQOUuLlLpHPoTm8Cuw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  33. 插件内如有使用自定义函数,请务必在自定义函数前加插件标识_或使用命名空间进行自定义函数
  34. eUEKFtjnAQMzswRbXmF7ZazmRZq4gAoRxCA2/A==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  35. API接口遵循最小数据返回,API在读取数据库数据并返回时,遵循最小数据返回,只返回客户端当前请求所需要的数据,而不是返回多余或冗余的信息
  36. sZObhUXdgRyivKTH88kW8h7WtsLukEPT5SUMsg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  37. 插件内不允许使用或包含AI生成的图片、文本、音频等资源
  38. tFZfnwsohCWiPIYLc7JEe0qjvOkhl6tLyxpr6g==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  39. 引用第三方资源或依赖包时,是否做好版权标识或链接、License文件存储
  40. rgziUHoRcNFlQnAsSmRFEnNuHPQmn2WvSW5vGg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  41. 插件含有UGC内容时,必须有后台审核或API内容安全审核,如果是小程序可接入微信官方内容安全审核接口
  42. IlpzBvDRufwXANOqKgfGE6+AthJBXUBOS5+kiw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

插件依赖规范

PuxACehivBqETpjSmbmeV1IUqR3AbsLZWRmfvQ==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

我们在开发FastAdmin应用插件中如果需要依赖到插件市场的插件时,需要注意以下依赖规范:

JmPHOwvqXKeZpEcxSstlV+2Ikyd9dGBLgu/osg==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  1. 如有必选依赖插件时,必须包含一款免费插件,确保基础功能可用,例如(编辑器、短信发送)
  2. aAQDnJXxpbZTWmkdJCPalwmmVI59Qupb++9Naw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  3. 如有可选依赖插件时,应用插件可以是收费的,但插件在没有安装这些可选依赖插件时,必须能够正常运行,以保证插件的灵活性和兼容性。
  4. caRKBMFWtkUjbvJxTMr1r37lfYVCB8ruSY3edA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。
  5. 在开发自己的插件时,要尽量确保插件在没有安装可选依赖插件的情况下仍能正常运行,以提供更好的用户体验。
  6. usqgBOzAVYtJDZdbfmPpP4aFmnjzfv+oWLz6wQ==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

版本号规范

yPipVYgDNuXUrCozu48DRhhWFSufRjsjV0JjYw==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

我们在开发FastAdmin应用插件时需做好版本号的更新和维护。
版本格式:主版本号.次版本号.修订号

lAukpUwYzebKMCdElThjOXvqOjKtXWRNGVCvAQ==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

版本号递增规则

aQeJfEpyCwrHWcvDTxFr0+tmAxDZv1EJWBFvLQ==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

1.主版本号:当你做了不兼容的 API 修改。
2.次版本号:当你做了向下兼容的功能性新增。
3.修订号:当你做了向下兼容的问题修正。

AetdlfJcUZyMSTzGka0db7TQulJba4HXa+ps1g==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

具体语义化规范请参考:https://semver.org/lang/zh-CN/

BUOERAaxsoYleJqTB1EjtphrAD6fK3Io3nwl9A==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

命名规范

fCzgBMuXPskaywNhjeHoiLbzIbgaL2SuUb++YA==著作权归作者所有,未经许可,禁止转载、复制此文档的任何内容。

具体命名规范可以参考:https://www.kancloud.cn/manual/thinkphp5/118007

文档最后更新时间:2025-11-18 15:17:08
著作权归应用插件开发者所有,未经许可,禁止转载、复制此文档的任何内容。

文档
目录

深色
模式

切换
宽度