跳到主要内容

应用市场重构为AppHub

· 阅读需 6 分钟

在清林云发布的时候,有一个简单的应用市场,组织可以将自定义应用发布上架,供其他用户浏览或安装,能够查看基础的 API 文档等。

经过一段时间的测试后,我们发现了一些简易版本的不足,同时也收到了很多客户的建议,在讨论和规划后,我们重构了应用市场,并命名为 AppHub。

版本控制

以前的版本控制系统是基于 API 的,一个应用内的 API 有不同的版本号,这种方式造成了部分用户的使用困惑,所以我们重构成了以应用为基础的版本控制系统,现在当开发者发布应用版本后,所有 API 都会创建一个该版本的镜像供用户使用,类似于 NPM 包的概念,而且镜像版本不再支持修改和删除。

应用的默认版本从 v1 修改为 latest,更贴近 NPM 的形式。新增应用的开发版本dev,在控制台对 API 的修改会实时更新到dev版本,调试功能将默认调用dev版本。

发布应用版本将会为当前 dev 版本的创建两个镜像,一个是以版本号为基础的镜像,一个是latest版本。点击发布时可以选择版本号,假如我们已经拥有一个1.0.0版本的应用修改后即将发布版本,那么版本号有三种选择,选大版本则是2.0.0,适用于有大量更新的情况;选中版本是1.1.0,适用于有特性更新的情况;选小版本是1.0.1,适用于小修小补的情况。

应用类型

应用可以选择私有或公开,创建时默认为私有应用,仅组织自己的环境可以调用。

在应用信息界面点击上架后可以上架该应用到应用市场赚取 RU,其他用户能在应用市场搜索发现该应用和 API 文档,可以安装到用户所在的组织。

如果用户安装应用后,该应用所属的组织下架该应用,安装了的用户不受影响,可以继续使用原有版本的 API。

我们将来也会更新开源应用的功能,也就是用户可以开源自己设计的应用,其他用户可以看到所有 API 的流程详情,并能提交 Pull request 优化和修改,类似 github 的形式。

三种类型的应用都可以设置定价高于成本。但私有应用没有必要,赚取的还是自己的 RU。公开应用就和以前的一样,设置合理的定价,赚取 RU。开源应用来源于开源精神,但也可以通过第三方、外部控制台、增值服务等方式获得收益。

文档优化

我们优化了整个 API 文档,在原有的参数表格中根据 API 步骤自动添加了可能会用到的额外参数。同时也支持了多级参数,比如,当调用某 API 时需要如下格式:

{
"appId": "appId",
"api": "api",
"version": "latest",
"args": {
"a": {
"b": ""
}
}
}

原有的参数设置中不支持,现在可以在参数上写 a.b 即可代表上述形式。

此外,我们添加了请求示例返回数据示例,可以让开发者直接复制请求模板代码,也可以看到大概的返回数据从而让调用 API 更加胸有成竹。

apidoc

为了提高了应用的可见性、安全性,当 API 中使用了其他应用的 API 时,API 文档中会显示调用的应用 ID 和 API,当使用 HTTP 步骤时文档会显示 HTTP 的地址和请求方式。

Roadmap

我们将持续增强应用市场 AppHub,计划中有以下特性:

Issues 功能,供使用者报告 Bug,讨论功能,提供建议等。

Wiki 文档功能,当首页文档不足以描述完整功能时,可以使用 Wiki 写完整的文档。

BaaS 应用微前端功能,实现应用数据的高级管理功能,打通完整流程。


以上就是 AppHub 这个名字的由来,感谢 GitHub、NPM、AppStore 等产品提供的思路,清林云 AppHub 将持续为用户提供更便捷高效使用 BaaS 的服务。