Skip to content

API发布

说明:HTTP转WS场景下,业务服务接口一定为“POST”类型接口
  1. 使用manager账号(默认密码:000000)登录系统,点击开发门户,进入“工作台”页面。

    2.1.1-1

  2. “工作台”页面,在“我的系统”页签中,点击系统卡片上的“API快速发布“按钮,弹出“API快速发布“弹窗。

    2.1.1-2

  3. “API快速发布“弹窗,选择”HTTP“页签,点击”HTTP转WS“按钮,进入”新增HTTP转WS“页面。

    2.1.5.1-1

  4. ”新增HTTP转WS“页面,参考字段说明表格,填写“业务信息配置”页签中内容

    2.1.5.1-2

    参数说明
    所属系统API所属系统
    所属服务API所属服务,若没有对应服务,请参考 步骤5 新增服务
    接口名称业务接口名称
    接口编码业务接口编码
    请求方式业务请求方式:GET、POST、DELETE、PUT、PATCH;HTTP转WS场景中的业务接口一定为 POST类型 接口,请选择 POST类型 接口作为业务服务
    业务URI业务接口URL路径,例如:/test或/api/test
    接口描述业务接口描述
    业务服务地址业务服务地址信息,若没有对应对应业务服务地址,请参考 步骤6 新增业务服务地址
  5. 若没有接口所属服务,请点击“所属服务”字段右下角“请新增”按钮,弹出“新增服务”弹框,

    2.1.1-5

    参考字段说明表格,填写服务信息,点击“确定”按钮,保存服务数据。

    2.1.1-6

    参数说明
    服务系统服务所属系统,此处默认为写入的系统
    服务编码服务的唯一标识
    服务名称服务名称
    服务状态上架,下架,默认上架
    服务负责人服务负责人,选员工
    服务通知服务下的接口变更时,是否通知,默认停用
    服务描述服务描述
    是否告警服务下的接口异常时,是否告警,默认停用
  6. 若没有接口所属业务服务地址,请点击“业务服务地址”字段右下角“请新增”按钮,弹出“新增业务服务地址”弹框

    2.1.1-7

    参考字段说明表格,填写业务服务地址信息,点击“确定”按钮,保存业务服务地址数据

    2.1.1-8

    参数说明
    所属系统业务地址所属系统
    业务名称业务名称
    协议业务协议,可选填写 HTTP、HTTPS、gRPC、TCP、UDP、HL7、lb等,若为“HTTPS”需填写“证书”字段
    业务IP业务IP地址
    业务端口业务地址端口
    业务描述业务地址描述
    证书HTTPS协议证书
  7. “业务信息配置”信息填写完成后,点击“下一步”按钮,进入“接口发布”页面,参考字段说明表格,填写发布信息,点击“发布”按钮,发布HTTP转WS接口。

    2.1.5.1-3

    参数说明
    代理端口ESB代理API的端口
    代理URIESB代理API的URL,比如:/test或/api/test
    WSDL地址WebService WSDL地址
    2种写入方式:
    1:手动写入WSDL地址(举例:WebService WSDL )
    2:点击“浏览”按钮,选择本地WSDL文件(举例:WSDL文件
    导入按钮WSDL地址填写完成后,点击“导入”按钮,完成WebService信息导入
    选择服务WebService信息导入后,下拉选择WebService 服务项,此场景选择“WeatherWebService”选项
    选择PortWebService信息导入后,下拉选择WebService Port,此场景选择“WeatherWebServiceSoap”选项
    业务操作WebService信息导入后,下拉选择WebService 操作,此场景选择“getSupportCity”业务操作
    重试次数重试次数,默认3
    发布说明该接口发布说明
    路由规则根据条件判断是否对请求进行路由转发,可选“轮询”或“自定义”,默认“轮询”,无需修改
    请求报文转换对请求报文格式进行转换,可选“穿透”、“XML转JSON”、“JSON转XML”,默认“穿透”,无需修改
    响应报文转换对响应报文格式进行转换,可选“穿透”、“XML转JSON”、“JSON转XML”,默认“穿透”,无需修改
    选择服务器选择ESB服务器组,发布接口

    WebService信息导入方式有2种:

    1:填写WSDL地址(举例:WebService WSDL ),点击“导入”按钮,导入WebService数据。

    2:点击“浏览”按钮,选择本地WSDL文件(举例:WSDL文件),点击“导入”按钮,导入WebService数据。

  8. 进入开发门户,点击菜单“API管理”>"我的发布",进入“我的发布”页面,选择左侧组织树中接口所属系统,在右侧界面可查看本章节创建的HTTP转WS接口的发布记录。

    2.1.5.1-4