注册 API 服务后,您需要进行相关配置才能使用 API 服务,尤其是 HTTP 类型的 API 服务。只有 API 服务状态为 开通 才能被调用。您需要手动开通 HTTP 类型的 API。
API 包括以下类型的参数配置:
欲了解详细的参数介绍及配置规则,点击以上配置类型名称。
要配置 API,完成以下步骤:
根据不同类型的 API 服务,编辑相应的参数值:
/pets/${id}
。网关支持为所有请求添加或者删除 header。在 header 设置 区域,点击 修改 进入打开编辑模式后,即可通过点击 Add 可以添加一条规则。每条规则包含 位置、类型、headerKey、value 和 操作 五个属性。
限流配置包括限流模式、限流值、限流响应:
{"resultStatus":1002,"tips":"顾客太多,客官请稍候"}
其中,
{
"result": "==此处为定制响应内容,请填写==",
"tips": "ok",
"resultStatus": 1000
}
result
为定制的响应数据,JSON
格式。只有 resultStatus
为 1000 时,客户端才会取此字段处理。tips
为定制的限流提示。若 resultStatus
为 1002,会取此字段提示用户。resultStatus
为限流返回的结果码,具体含义请参见 网关结果码。缓存 API 的响应,减轻业务系统压力。具体配置参见 API 缓存。
请求参数设置
/pets/${id}
,此时参数名称应为 id
。String
、Int
、Long
、Float
、Double
、Boolean
。响应结果设置
响应结果类型为基础类型或者自定义的数据模型。
在文档使用中是否遇到以下问题
更多建议
匿名提交