当consumer在编写代码去调用api之前,一定要知道api的入参和返回结果的定义是什么样的,了解的方式基本也就是参考provider所提供的api文档。
但是文档上的内容都是静态的,只是通过参数定义说明和返回示例的内容往往满足不了consumer的要求,也很难覆盖每个接口的全部使用场景,这时候api网关的调试api功能可能会给您带来帮助。
首先provider配置好api之后发布到测试环境或者是线上环境。
api网关是基于app进行调用的,所以provider要把已经发布的api授权给一个app。
完成以上两步操作后,可以在 应用管理 --> 应用详情 --> 已授权的api 中,看到调式api入口,见下图。
!
打开调试api之后,页面会自动加载api定义的信息:
1)接口域名,显示的是这个api所属分组的自定义域名,如果分组上没有绑定自定义域名,则显示二级域名,二级域名不支持https调试。
2)请求参数,调用api需要的参数,包括headers、query和body,如果定义了示例值系统会自动填上。
3) app,系统会自动填充appkey和appsecret,调式的时候如果需要可以随时更换。
4) 点击“发送请求”,页面右侧会显示调试信息,包括request和response详细信息,方便用户排查自己遇到的问题(x-ca-error-message字段为错误码字段),见下图。