下游开发规范 / SDK 接入指南
本指南是下游项目 SDK 接入的统一规范入口。它不替代 clsdk-go、clsdk-pcweb、clsdk-clapp 的 SDK README,也不复制三个 SDK 仓的全部细节;它负责说明项目接入资料、SDK 选型、Gitee tag 安装方式、中间件应用菜单权限准备和验收要求。
本指南只覆盖正式接入口径,不写真实密钥,不提交 SystemKey、PermanentKey、tempKey,也不要求下游前端保存服务态密钥。
阅读顺序
- 阅读《下游项目接入总览》,确认中间件、后端、PCWEB、APP / 小程序的职责边界。
- 使用《下游项目接入资料模板》补齐模块资料,尤其是
addonsType、appId / appUuid、仓库路径、角色、菜单初稿、默认页和明确不做的内容。 - 按《SDK 选择与版本说明》选择 SDK,并以 SDK 仓 README 与 Gitee tag 为准完成安装。
- 完成《中间件准备流程》后,再分别进入后端、PCWEB、APP / 小程序接入流程。
- 用菜单、权限、Casbin 三篇规范核对
pageCode、actionCode、grantApis是否形成闭环。 - 最后按《下游项目验收清单》验收,遇到异常按《常见问题排查》定位。
正式边界
- 本指南只处理下游项目 SDK 接入的统一入口和验收口径。
- 不修改
clsdk-go、clsdk-pcweb、clsdk-clapp三个 SDK 仓。 - 不修改任何配送端或其他下游业务仓。
- 不写配送端业务逻辑,只使用 demo 菜单示例说明结构。
- 正式项目必须使用 Gitee tag,不允许正式提交本地
replace或本地file:依赖。