API列表

API创建

创建API的流程为：

1) 首先点击能力开放—API列表—创建API按钮，进入API创建页面

2) 第一步（基本信息）中，下拉选择API所属分组、API名称、描述。

3) 第二步（定义API请求）中填写请求PATH、HTTP Metuod、请求入参信息。

参数	描述
请求PATH	输入有效的请求PATH，如/getUserInfo
HTTP Method	选择GET、POST、DELETE、PUT、PATCH
参数名	包含英文,数字,下划线, 减号, 并必须英文开头，header参数名请勿包含下划线
参数位置	选择QUERY或HEAD
类型	下拉选择正确的类型
必填	选择是否必填
默认值	提供参数默认值
示例	提供参数示例
参数验证	输入参数验证正则表达式

4) 第三步（定义API后端服务）中选择协议、填写后台服务地址、后端请求PATH、HTTP Method、后端超时时间、后端服务参数、常量参数、自定义系统参数

参数	描述
协议	HTTP、HTTPS，支持复选
后端服务地址	格式 host:port
后端请求PATH	输入有效的PATH，如 /getUserInfo
HTTP Method	选择GET、POST、DELETE、PUT、PATCH
后端超时	正整数，默认30000ms
后端服务参数	参数名（包含英文,数字,下划线, 减号, 并必须英文开头，header参数名请勿包含下划线）、参数位置
常量参数	参数名、参数值、参数位置、描述
自定义系统参数	系统参数名、参数名、参数位置。描述

5) 第四步（定义返回结果）中选择返回ContentType、返回结果示例、失败返回结果示例、错误码定义、返回结果备注、错误码定义。点击“创建”完成API的创建。

参数	描述
返回 ContentType	支持选择透传ContentType、TEXT、JSON、XML、HTML、BINARY
返回结果示例	填写正确结果示例
失败返回结果示例	填写失败结果示例
返回结果备注	JSON、XML时展示
错误码定义	错误码、错误信息、描述

API调试及发布

1) API调试时支持点击API列表操作中—更多—调试按钮进入调试页面

2) API发布需联系客户经理进行发布，发布后可以在API列表操作中—更多—发布历史中查看。

这篇文档是否帮助您解决了问题? 有帮助没帮助