# API发布
使用manager账号(默认密码:000000)登录系统,点击开发门户,进入“工作台”页面。
点击菜单“API管理”>“API注册”,打开API注册管理界面,左侧显示组织树结构(包括域、系统),右侧显示已创建的API列表。
在“API注册”界面,选择左侧组织树中API所属系统节点,再点击“API创建”按钮,打开API创建类型选择界面。
在“API创建”界面,进入“HTTP”页签,点击”HTTP穿透“按钮,进入”新增HTTP穿透“页面。
”新增HTTP穿透“页面,参考字段说明表格,填写“业务信息配置”页签中内容,(此场景中”导入方式“选择”Swagger文件导入“或“SwaggerURL地址”)。
参数 说明 所属系统 API所属系统 所属服务 API所属服务,若没有对应服务,请参考 步骤6 新增服务 导入方式 业务信息导入方式,可选:手动录入、Swagger文件导入、SwaggerURL导入
此场景选择:Swagger文件导入 或 SwaggerURL导入swagger字段 若“导入方式”选择“Swagger文件导入”,则点击“点击上传”按钮,上传包含swagger内容的Json格式文件。
若“导入方式”选择“SwaggerURL导入”,则填写业务接口服务的swagger地址,例如:http://ip:port/v2/api-docs业务服务地址 业务服务地址信息,若没有对应对应业务服务地址,请参考 步骤7 新增业务服务地址 若没有接口所属服务,请点击“所属服务”字段右下角“请新增”按钮,弹出“新增服务”弹框。
参考字段说明表格,填写服务信息,点击“确定”按钮,保存服务数据。
参数 说明 服务系统 服务所属系统,此处默认为写入的系统 服务编码 服务的唯一标识 服务名称 服务名称 服务状态 服上架,下架,默认上架 服务负责人 服务负责人,选员工 服务通知 服务下的接口变更时,是否通知,默认停用 服务描述 服务描述 是否告警 服务下的接口异常时,是否告警,默认停用 若没有接口所属的业务服务地址,请点击“业务服务地址”字段右下角“请新增”按钮,弹出“新增业务服务地址”弹框。
参考字段说明表格,填写业务服务地址信息,点击“确定”按钮,保存业务服务地址数据。
参数 说明 所属系统 业务地址所属系统 业务名称 业务名称 协议 业务协议,可选填写 HTTP、HTTPS、gRPC、TCP、UDP、HL7、lb等,若为“HTTPS”需填写“证书”字段 业务IP 业务IP地址 业务端口 业务地址端口 业务描述 业务地址描述 证书 HTTPS协议证书 “业务信息配置”信息填写完成后,点击“下一步”按钮,进入“接口导入”页面,在“导入接口”界面,选择需要导入的接口,点击页面中间“>”按钮导入已选择接口,点击“保存”按钮,保存HTTP穿透接口。
点击菜单“API管理”>“API注册”,进入“API注册”界面,选择左侧组织树中本章节创建接口的所属系统,右侧界面展示该系统下的接口列表,选择本章节创建的HTTP穿透接口,点击操作列”发布“按钮。
进入“接口发布”页面,参考字段说明表格,填写发布信息,点击“提交”按钮,发布接口。
参数 | 说明 |
---|---|
代理端口 | ESB代理API的端口 |
代理URI | ESB代理API的URL,比如:/test或/api/test |
重试次数 | 重试次数,默认3 |
发布说明 | 该接口发布说明 |
路由规则 | 根据条件判断是否对请求进行路由转发,可选“轮询”或“自定义”,默认“轮询”,无需修改 |
请求报文转换 | 对请求报文格式进行转换,可选“穿透”、“XML转JSON”、“JSON转XML”,默认“穿透”,无需修改 |
响应报文转换 | 对响应报文格式进行转换,可选“穿透”、“XML转JSON”、“JSON转XML”,默认“穿透”,无需修改 |
发布至网关服务器 | 是否将该接口发布至网关服务器,默认不勾选 |
ESB服务器 | 选择ESB服务器组,发布接口 |
- 进入开放门户,点击菜单“API管理”>"我的发布",进入“我的发布”页面,选择左侧组织树中API所属系统,在右侧界面可查看本章节创建的HTTP穿透接口的发布信息。