单击左侧导航树中的[服务发布/接口管理]菜单项,进入接口管理页面。
在界面左上方选择待发布接口的服务网关。
单击<发布接口>按钮,弹出配置窗口。
配置基础配置、接入后端服务、定义接口请求、配置策略等参数。参数说明参见下表:
参数配置完成后,单击<新建>按钮,完成操作。
当所选网关实例未开启“服务发布审批”时,新建完成后接口即发布成功,为“上线”状态。
当所选网关实例已开启“服务发布审批”时,新建完成后接口为“待审批”状态。系统会自动生成审批流程,待系统管理员或项目管理员在界面右上角[流程/代办审批]中审批通过后,方可发布成功,接口变为“上线”状态。
服务消费者根据新建网关时配置的网关IP、端口号和本步骤中配置的请求地址即可访问本接口。
基础配置参数如下表:
参数 |
说明 |
|
基础配置 |
接口名称 |
接口在本系统的显示名称,策略绑定接口、订阅服务时需通过此名称选择本接口。支持中文、英文字母、数字和特殊字符“.”,“-”,“_”,以英文字母或中文开头,长度1到64个字符。 |
描述 |
自定义描述,0-128个字符。 |
|
接口分组 |
选择新建接口组配置的分组,实现接口间的逻辑隔离和统一管理。 |
后端服务类型为HTTP/HTTPS类型时,需要配置的参数说明如下表:
· 对于WebService类型的API,需保证WSDL配置中,wsdl:input和wsdl:output标签的name属性有值(如图-1所示,位于图片中配置的底部)。 · 后端服务类型为WebService,则后续配置定义接口请求参数时,建议将请求方法配置为POST。 |
后端服务类型为WebService时,参考下图配置:
图-1 WebService类型API接口配置参数说明
表-1 WebService类型API接口配置参数说明
参数 |
说明 |
|
接入后端服务 |
后端服务类型 |
本接口可代理的后端服务的类型,选择WebService。 |
WSDL地址 |
请参考图-1,对应填写各参数。 |
|
命名空间 |
||
Endpoint地址 |
||
Binding名称 |
||
方法名称 |
||
SoapAction |
接口请求和配置策略参数如下表所示:
参数 |
说明 |
|
定义接口请求 |
请求协议 |
服务消费者请求本接口时使用的协议类型,包括HTTP或HTTPS。 应与接入后端服务时配置的协议保持一致。 |
请求方法 |
服务消费者请求本接口的方法,即API接口的请求方法,包括GET、POST、DELETE、PUT、PATCH、HEAD、OPTIONS、ANY。 其中ANY表示该API支持任意请求方法。请求方法为ANY的API的匹配优先级低于其它方法。 应与接入后端服务时配置的协议保持一致。 当后端服务类型为WebService时,建议将该请求方法配置为POST。 |
|
请求地址 |
服务消费者请求本接口时的路径,支持精确匹配。 服务消费者可根据新建网关时配置的网关IP、端口号和本请求地址访问本接口。 格式如:/users/{userId}/projects {}中的变量为请求参数,表示匹配"/"之间的一整段。 内容区分大小写。 |
|
保留Host请求头 |
请求后端服务时是否保留原Host请求头。 |
|
支持跨域(CORS) |
CORS(Cross-origin Resource Sharing,跨域资源共享)。如开启(CORS),则允许从其他领域请求网页上的受限资源。 |
|
配置策略 |
安全认证 |
选择认证策略策略,如无安全认证需求,选择“无认证”。各个策略的具体介绍请参见安全控制。 |
访问策略 |
选择访问策略策略,如无访问策略限制需求,不用选择。具体可参见配置访问策略。 |
|
流控策略 |
选择流量控制策略,如无流控策略限制需求,不用选择。具体可参见配置认证策略。 |