Api网关对调试Api的支持-阿里云开发者社区

开发者社区> 归邪> 正文

Api网关对调试Api的支持

简介: 当Consumer在编写代码去调用Api之前,一定要知道Api的入参和返回结果的定义是什么样的,了解的方式基本也就是参考Provider所提供的Api文档。 但是文档上的内容都是静态的,只是通过参数定义说明和返回示例的
+关注继续查看

Api网关对调试Api的支持

说明

当Consumer在编写代码去调用Api之前,一定要知道Api的入参和返回结果的定义是什么样的,了解的方式基本也就是参考Provider所提供的Api文档。

但是文档上的内容都是静态的,只是通过参数定义说明和返回示例的内容往往满足不了Consumer的要求,也很难覆盖每个接口的全部使用场景,这时候Api网关的调试Api功能可能会给您带来帮助。

如何使用

  1. 首先Provider配置好Api之后发布到测试环境或者是线上环境。
  2. Api网关是基于App进行调用的,所以Provider要把已经发布的Api授权给一个App。
  3. 完成以上两步操作后,可以在 应用管理 --> 应用详情 --> 已授权的API 中,看到调式API入口,见下图。
    !
  4. 打开调试Api之后,页面会自动加载Api定义的信息:

    1)接口域名,显示的是这个Api所属分组的自定义域名,如果分组上没有绑定自定义域名,则显示二级域名,二级域名不支持https调试

2)请求参数,调用Api需要的参数,包括Headers、Query和Body,如果定义了示例值系统会自动填上。

3) APP,系统会自动填充AppKey和AppSecret,调式的时候如果需要可以随时更换。

4) 点击“发送请求”,页面右侧会显示调试信息,包括Request和Response详细信息,方便用户排查自己遇到的问题(X-Ca-Error-Message字段为错误码字段),见下图。
api_2

最后附上 如何获取错误信息错误码查询表,希望对用户有所帮助。

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Api网关对调试Api的支持
当Consumer在编写代码去调用Api之前,一定要知道Api的入参和返回结果的定义是什么样的,了解的方式基本也就是参考Provider所提供的Api文档。 但是文档上的内容都是静态的,只是通过参数定义说明和返回示例的
2436 0
第八章 让Bootstrap轮播插件carousel支持左右滑动手势的三种方法
因为最近开发的项目涉及到移动设备上的 HTML5 开发,其中需要实现轮播效果。然后最快捷的方式,你知道的(Bootstrap),然后原生的 Bootstrap 的 carousel.js 插件并没有支持手势。
1060 0
支持中低频量化交易的单机数据平台
支持中低频量化交易的单机数据平台,使用InfluxDB存储实时交易数据,HDF5存储静态历史数据用于回测。
2461 0
iis6下配置支持.net4.0&发布网站[转]
iis6配置支持.net4.0 在win2003操作系统上发布两个网站,首先配置iis: 1.下载 .net framework 4.0   差不多48MB 2.安装 3.打开iis: 开始=>管理工具=>Internet 信息服务(IIS)管理器 4.
831 0
iOS10 适配 ATS(app支持https通过App Store审核) 韩俊强的博客
一. HTTPS 其实HTTPS从最终的数据解析的角度,与HTTP没有任何的区别,HTTPS就是将HTTP协议数据包放到SSL/TSL层加密后,在TCP/IP层组成IP数据报去传输,以此保证传输数据的安全;而对于接收端,在SSL/TSL将接收的数据包解密之后,将数据传给HTTP协议层,就是普通的HTTP数据。
881 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
7734 0
+关注
归邪
阿里云 — 高级研发工程师
2
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
文娱运维技术
立即下载
《SaaS模式云原生数据仓库应用场景实践》
立即下载
《看见新力量:二》电子书
立即下载