跳到主要内容
Sparq

Sparq 开发者中心

从一个插件、一套主题或一次 API 集成开始,构建可组合、可交付的应用能力。

插件清单、代码与构建产物组成 Sparq 开发流程

快速开始

选择开发方向,查看对应的准备事项和入口。

创建第一个插件

    查看开发要点
    Terminal

    开发指南

    围绕开发过程中的关键边界,找到下一步。

    插件结构与能力声明

    plugin.yaml 保存插件身份与协议兼容范围;Manifest 声明组件、入口和宿主贡献。Local 插件随宿主编译,Remote 插件通过独立进程提供能力。

    按生命周期装配服务,将 HTTP 路由、Schema Resource 和 Capability 接入对应边界,避免在模板或界面层承载业务规则。

    插件开发交流
    主题模板与静态资源

    theme.yaml 声明主题身份与视图映射,views/ 保存 Blade 模板,assets/ 保存样式、脚本和图片,第三方许可放入 licenses/

    通过布局与局部模板复用页头、页脚和导航。静态资源使用 asset() 生成地址;模板读取宿主提供的视图上下文,不直接访问数据库。

    浏览主题与模板
    账户认证与 API 调用

    平台账户接口使用 Bearer Token。请求头传入 Authorization: Bearer TOKEN,当前用户入口为 GET /cloud-api/usercenter/v1/me

    将令牌保存在受控环境中,不写入公开仓库或主题资源。按 HTTP 状态与响应业务码处理错误:401 表示需要有效身份,403 表示权限不足,429 表示请求受限。

    账户安全设置
    Schema 资源与管理界面

    使用 Schema 声明资源字段、选项、校验和视图,通过 Runtime 连接后端业务处理,再由 Schema Renderer 生成管理界面。

    迁移、资源协议和业务事务分别由其所属模块负责;普通内容页面与宿主管理界面沿用各自的展示边界。

    交流资源设计
    构建、打包与版本发布

    插件按 build、package、publish 组织交付。构建检查清单与依赖,打包消费构建产物,发布将版本与源码包提交至平台审核。

    发布前检查版本、依赖、资源许可与授权范围,并在实际宿主中验证安装和调用。主题发布同时维护模板市场清单与运行时主题清单。

    查看交付实践
    本地联调与故障排查

    首先确认宿主版本、插件运行模式及所需依赖,再按请求链路检查路由、身份、权限与能力调用。

    保留错误信息、复现步骤和最小示例。反馈问题时注明版本和运行环境,避免公开密钥、令牌或用户数据。

    向社区提问

    一起解决开发中的问题

    分享插件与主题实践,交流集成方案和交付经验。

    进入社区论坛