配置API

配置API信息包含API基本信息,服务接口,文档管理,接口分类等。

如果希望简单接入网关,仅将网关作为透明代理,可以略过本节,直接添加部署API。

基本信息

API管理>我的API>选择一个API>基本信息菜单下。

这里修改的信息和创建API时的信息一致。

服务接口

API管理>我的API>选择一个API>服务接口菜单下。

可以编辑这个API的服务接口。

强烈推荐按照swagger标准格式些swagger json文档导入,如果是比较简单的服务接口,可以使用控制台的编辑功能。

使用控制台编辑功能,按照如下步骤操作:

  1. 添加path

操作页面如下:

填写相应信息并保存。

  1. path添加operation

添加operation的操作界面如下:

这里的参数位置解释如下:

位置 说明
query 参数在url中,就是queryString中
body 参数在请求体中
header 参数在请求头中
path 参数在请求路径中,如path的uri为/path/{name},那么访问/path/zhangsan,这里的参数name的值就是zhangsan
formData 参数在form 表单中

如果需要更多的参数,可以点击+请求参数按钮来添加请求参数。

填写完所有信息后保存,添加多个operation后,可以通过如下图方式查看不同的operation

服务接口配置完成后,可以在网关门户>服务目录>选择API里看到响应的接口文档。

文档管理

API管理>我的API>选择一个API>文档管理菜单下。

这里使用markdown编写文档,左边是编辑区,右边是预览区。

编辑后点击保存即可在网关门户>服务目录>选择一个服务>服务文档中看到这篇说明文章。

接口分类

API管理>我的API>选择一个API>接口分类菜单下。

可以创建接口分类。

保存分类后,可以选择path属于这个分类:

上一篇:创建API 下一篇:部署API