MyBricks 上传&发布集成接口协议文档
一、接口协议
1.1 上传接口(搭建态,用于图片上传等):
POST
Content-Type: multipart/form-data
入参
出参
1.2 发布集成接口:
如果没有配置该接口,则默认保存到服务器磁盘
POST
Content-Encoding: gzip
Content-Type: application/json
tip: 传输数据的编码格式为 gzip,发布集成接口需要通过 gzip 格式解压使用。
入参:
出参:
请求 Demo
这是一个使用 nodejs 环境的请求 demo
如果要通过其他方式模拟发布集成请求,可以将上面文件里的 data 文件取出自行使用。
案例1:
●应用(管理应用)
○核心功能
■集成接口
●接收发布相关数据,将 Html 文件字符串进行上传
■拿到上传后的 html url,绑定 前端项目、前端项目路由地址、环境信息
○可扩展的功能
■定义前端项目路由
■回滚
■版本管理
■审批流
■...
●需要集成的项目,请求 应用接口,返回 html URL + 项目路由地址映射关系等信息
○'/a/b' => 'https:/xxx.html'
1.3 评论通知接口
配置路径
配置中心 -> PC应用 -> @消息评论通知接口
评论通知接口
POST
'Content-Type': 'application/json',
参数示例
接口返回
无要求
二、多环境配置教程
2.1 配置路径
2.2 多环境配置说明
2.3 搭建页面与多环境有关的功能 *
调试
1.没有在全局配置多环境时:可选择默认或自定义域名
a.默认:
如果域名没有包含绝对地址则使用当前页面的域名
b.自定义域名
可以自定义多个域名,并在插件的接口中通过 {MYBRICKS_HOST.变量} 的方式直接引用
连接器插件中通过变量引用自定义域名
2.已配置多环境时:支持选择环境和自定义域名
a.选择环境:
读取环境对应的默认接口前缀,保存到当前页面
如果在搭建页内修改了环境的路径前缀,那么在外部全局修改环境配置,此处的路径也不会再更新,只会新增未定义过的环境