API接入指南

接入流程

一个已经开发好的API接入网关的完整流程如下:

graph LR; A[登录控制台]-->B[创建API]; B-->C[部署API]; C-->D[编写服务接口]; D-->E[编写服务文档] E-->F[发布API];

登录控制台

登录控制台需要先申请开发者账号。

创建API

创建API是指在控制台创建一个API,这是一个API生命周期的开始阶段。

部署API

部署API是指将API部署到网关上,并允许客户端通过网关调用这个API。

注:此时API还没正式发布,开发人员可以测试这个API,但是其他人在服务目录中看不到这个API。

编写API服务接口

服务接口指的是这个API下所有允许访问的虚拟路径以及每个路径的HTTP请求方法和参数。

假设某个API的访问地址是:

https://developer.bingosoft.net:12000/demo

并且这个API有如下两个功能:

查询用户:GET https://developer.bingosoft.net:12000/demo/getuser
查询组:GET https://developer.bingosoft.net:12000/demo/group

那么需要在网关中配置两个服务接口:

GET /getuser 
GET /group

API服务接口是在网关中描述API的重要组成部分,所有API都要求编写服务接口。

关于服务接口的更详细内容请看服务接口

编写服务文档

服务文档是对这个API的业务功能的具体描述以及详细说明,这里需要介绍清楚API的功能,以便客户端了解这个API是否自己需要的功能。

发布API

发布API是指将API正式发布到服务目录,客户端可以通过服务目录查看API文档和服务接口。

API生命周期

一个API在网关中完整的声明周期会经过如下几个阶段:

graph LR; A[创建]-->B[配置]; B-->C[部署]; C-->D[发布]; D-->E[使用]; E-->F[下架]

在上面的生命周期中,API使用的过程是在网关正常运行的过程,其他几个过程在控制台都有对应的管理,参考:

上一篇:API接入 下一篇:创建API