1.8.5 服务开发最佳实践

优质
小牛编辑
128浏览
2023-12-01

服务开发最佳实践

更新时间:2018-03-20 21:45:44

服务开发的流程从创建服务开始,每一个服务下可以创建多个版本,每一个版本下可以创建多个API。

一、服务

我们建议为每个服务取一个有意义的名字,同时为该服务打上标签。每一个服务最终将是一组API的集合,这些API具有某些共性,存在于一个服务之下。比如KV存储服务,旗下必然有put, get, delete这几个API。

二、版本

每个服务可以拥有多个版本,服务的版本建议从1.0.0开始,依次往上递增。
每个版本下面可以创建多个API,API的名称和路径不能重复。
随着版本的递增,我们希望您在高版本下创建更多的API,让版本逐步强大起来。当然,对于您在后续不需要的API,亦可以在版本中删除。

三、API

API在整个服务开发中扮演着极其重要的角色,他让一个服务、一个版本真正有了意义。

API分为托管API和非托管API

1、非托管API

Keep Open and Look Forward

对于非托管API,我们提供了第三方API接入的能力,比如您可以创建一个非托管API,接入GitHub的开放API,从而在我们的平台上,您就具备了访问GitHub API的能力。
您还可以通过非托管API,访问您的个人网站提供的服务。只要您的服务具备公网访问的能力。
总之,对于非托管类型的API,我们的原则是:海纳百川,有容乃大。

2、托管API

Just Compose

对于托管API,我们提供了编排的能力,从而让您能够将多个原子的API组合成新的API,大大提高了API的复用性,降低了开发成本,让开发复杂的API变得更为容易。目前对于编排的API,我们提供了请求节点、服务节点、脚本节点、路由节点、返回节点,让您可以轻松快速地完成API的编排开发,示例如下:

compose01.png | center | 752x334

请求节点 :请求节点是一个编排流的起点,您可以在请求节点中自定义请求参数。
服务节点 :服务节点是API访问节点,通过服务节点,您可以轻松地访问官方服务和自定义的服务和API,而无需编写任何脚本,即为便利。
脚本节点 :脚本节点是一种万能节点,它的功能非常强大,服务节点和路由节点的功能,通过脚本节点都能实现。目前我们只支持您使用node.js编写脚本,且需遵循一定的规范,详情参见脚本节点开发规范。我们并不推荐您过多地使用脚本节点,因为这样可能会降低您使用服务编排的乐趣。
路由节点 :路由节点是分支节点,是典型的if else if else的逻辑,也只有路由节点可以拥有多个出口。值得注意的是,如果您在路由节点中定义的规则一个都没有被匹配到,则编排流程将结束,默认将返回上一个节点的返回值。
返回节点 :返回节点意味着流程的结束,这里将汇聚编排的结果。
其中脚本节点需遵循一定的开发规范,详见脚本节点编码指导。

所有的API调用支持http和https协议,如果您想使用https协议,请您申请一个自定义域名,并为之绑定证书。
我们建议您这么做,因为这样会很有安全感。