发布接口

  1. 单击左侧导航树中的[服务发布/接口管理]菜单项,进入接口管理页面。

  1. 在界面左上方选择待发布接口的服务网关。

  1. 单击<发布接口>按钮,弹出配置窗口。

  1. 配置基础配置、接入后端服务、定义接口请求、配置策略等参数。参数说明参见下表:

  1. 参数配置完成后,单击<新建>按钮,完成操作。

  1. 服务消费者根据新建网关时配置的网关IP、端口号和本步骤中配置的请求地址即可访问本接口。

基础配置

基础配置参数如下表:

参数

说明

基础配置

接口名称

接口在本系统的显示名称,策略绑定接口、订阅服务时需通过此名称选择本接口。支持中文、英文字母、数字和特殊字符“.”,“-”,“_”,以英文字母或中文开头,长度164个字符。

描述

自定义描述,0-128个字符。

接口分组

选择新建接口组配置的分组,实现接口间的逻辑隔离和统一管理。

 

接入后端服务

1.      后端服务类型为HTTP/HTTPS

后端服务类型为HTTP/HTTPS类型时,需要配置的参数说明如下表:

参数

说明

接入后端服务

后端服务类型

本接口可代理的后端服务的类型,选择HTTP/HTTPS

请求协议

本接口请求后端服务时使用的协议类型,包括HTTPHTTPS

请求方法

本接口请求后端服务的方法,即API接口的请求方法,包括GETPOSTDELETEPUTPATCHHEADOPTIONSANY

其中ANY表示该API支持任意请求方法。

自定义路径转发

当设置为开启时,自定义截取源请求路径转发至后端服务。调用的请求Path将以创建时填写的API请求Path为前缀,支持接口定义多个不同Path

例如,请求路径为/test/AA,当自定义截取前缀为/test时,通过/test/AA/xx可以调用到后端服务路径为/AA/xxAPI

后端服务Path(默认)

本接口负责代理的服务提供方的路径,支持精确匹配。

格式如:/users/{userId}/projects

  • {}中的变量为请求参数,表示匹配"/"之间的一整段,不支持匹配"/"之间的一部分,例如/abc{userId}。尾部的请求参数可以添加+号,例如/users/{p+},其中变量p匹配1或多段"/"之间的部分。

  • 内容区分大小写。

重试次数

为请求指定重试次数。超过重试次数后仍未成功,则请求失败。取值范围为1~20

超时时间(毫秒)

即每次请求的超时时间。超时仍未成功,则执行重试。取值范围为:0~3600000毫秒。

版本号

当前发布接口的版本号。1-64个字符;支持英文字母、数字和特殊字符“.”,“-”,“_”;且以点为分隔符,分隔后每一段都不能以特殊字符为开头或结尾;不能出现连续的点。

版本特性

对版本的特性描述,0-255个字符。

服务接入方式/后端服务(默认)

自定义

通过IP地址/域名和端口号的方式定位到后端服务,并通过权重定义后端。

  • 服务地址:本接口负责代理的服务提供方的IP地址/域名和端口号,格式为“主机:端口”,端口号未指定则使用默认端口。HTTP协议,默认端口号为80HTTPS协议,默认端口号为443。单击按钮可添加多个后端服务,实现后端服务的负载均衡。单击<快速添加>按钮,弹出编辑文本框,可以在文本框内完成多行数据的编辑后,单击<确定>按钮,一起提交。

  • 文本框内输入格式说明如下:请输入格式:“主机:端口”,主机为IP或域名,端口未指定则使用默认端口。协议为HTTP,默认端口80;协议为HTTPS,默认端口443多个配置之间用空格或者换行隔开,例如:
    192.135.12.0:9000
    192.135.12.1:9000

  • 权重:当配置多个后端服务时,可以通过配置权重实现后端服务的负载均衡轮询,取值范围为0~1000。例如后端服务ab的权重分别为500200,则访问请求到ab的比例分别为5/72/7

  • 负载均衡算法:

  • 默认为“轮询”,即通过权重实现负载均衡。

  • 最小连接:将请求发送给当时连接数最小的后端服务处理。

  • 一致性哈希:需配置哈希类型和参数,系统会自动计算出hash值完成负载均衡。支持的类型包括HeaderCookieIP

注册中心

选择注册中心来对接后端服务。单击<选择>按钮,选择EurekaNacos类型的注册中心,勾选服务然后单击<确定>按钮完成选择。

服务接入方式/后端服务(默认)

  • 自定义:通过IP地址/域名和端口号的方式定位到后端服务,并通过权重定义后端。

  • 服务地址:本接口负责代理的服务提供方的IP地址/域名和端口号,格式为“主机:端口”,端口号未指定则使用默认端口。HTTP协议,默认端口号为80HTTPS协议,默认端口号为443。单击按钮可添加多个后端服务,实现后端服务的负载均衡。单击<快速添加>按钮,弹出编辑文本框,可以在文本框内完成多行数据的编辑后,单击<确定>按钮,一起提交。

  • 文本框内输入格式说明如下:请输入格式:“主机:端口”,主机为IP或域名,端口未指定则使用默认端口。协议为HTTP,默认端口80;协议为HTTPS,默认端口443多个配置之间用空格或者换行隔开,例如:
    192.135.12.0:9000
    192.135.12.1:9000

  • 权重:当配置多个后端服务时,可以通过配置权重实现后端服务的负载均衡轮询,取值范围为0~1000例如后端服务ab的权重分别为500200,则访问请求到ab的比例分别为5/72/7

  • 负载均衡算法:

  • 默认为“轮询”,即通过权重实现负载均衡。

  • 最小连接:将请求发送给当时连接数最小的后端服务处理。

  • 一致性哈希:需配置哈希类型和参数,系统会自动计算出hash值完成负载均衡。支持的类型包括HeaderCookieIP

配置健康检查

TCP检查间隔

设置TCP检查的时间间隔,取值范围为5~300秒。

超时时间

设置TCP连接超时时间,取值范围为1~60秒。

不健康阈值

设置不健康阈值,单位为次。在当前状态为健康的情况下,后端服务请求失败的次数达到阈值时,即标记为不健康。后端服务请求失败存在包括两种情况:TCP连接失败和后端服务响应超时。

健康阈值

设置健康阈值,单位为次。在当前状态为不健康的情况下,TCP检查成功的次数达到阈值,即标记为健康。

 

2.      后端服务的类型为WebService

·          对于WebService类型的API,需保证WSDL配置中,wsdl:inputwsdl:output标签的name属性有值(如-1所示,位于图片中配置的底部)。

·          后端服务类型为WebService,则后续配置定义接口请求参数时,建议将请求方法配置为POST

 

后端服务类型为WebService时,参考下图配置:

图-1 WebService类型API接口配置参数说明

 

表-1 WebService类型API接口配置参数说明

参数

说明

接入后端服务

后端服务类型

本接口可代理的后端服务的类型,选择WebService

WSDL地址

请参考-1,对应填写各参数。

命名空间

Endpoint地址

Binding名称

方法名称

SoapAction

 

定义接口请求和配置策略

接口请求和配置策略参数如下表所示:

参数

说明

定义接口请求

请求协议

服务消费者请求本接口时使用的协议类型,包括HTTPHTTPS

应与接入后端服务时配置的协议保持一致。

请求方法

服务消费者请求本接口的方法,即API接口的请求方法,包括GETPOSTDELETEPUTPATCHHEADOPTIONSANY

其中ANY表示该API支持任意请求方法。请求方法为ANYAPI的匹配优先级低于其它方法。

应与接入后端服务时配置的协议保持一致。

当后端服务类型为WebService时,建议将该请求方法配置为POST

请求地址

服务消费者请求本接口时的路径,支持精确匹配。

服务消费者可根据新建网关时配置的网关IP、端口号和本请求地址访问本接口。

格式如:/users/{userId}/projects

{}中的变量为请求参数,表示匹配"/"之间的一整段。

内容区分大小写。

保留Host请求头

请求后端服务时是否保留原Host请求头。

支持跨域(CORS)

CORSCross-origin Resource Sharing,跨域资源共享)。如开启(CORS),则允许从其他领域请求网页上的受限资源。

配置策略

安全认证

选择认证策略策略,如无安全认证需求,选择“无认证”。各个策略的具体介绍请参见安全控制

访问策略

选择访问策略策略,如无访问策略限制需求,不用选择。具体可参见配置访问策略

流控策略

选择流量控制策略,如无流控策略限制需求,不用选择。具体可参见配置认证策略