Api网关对调试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字段为错误码字段),见下图。

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

时间: 2024-08-30 22:08:04

Api网关对调试Api的支持的相关文章

告别繁荣缛节,阿里云资源编排支持API网关

阿里云ROS的API 网关资源11月初正式上线,资源编排(ROS) 支持在模板中定义API 网关资源,助力用户快速.便捷管理发布自己的API.目前,阿里云ROS 产品免费提供给广大用户. 资源编排服务 (Resource Orchestration Service 简称 ROS) 是一款帮助阿里云用户简化云计算资源管理和自动化运维的服务.用户遵循 ROS 定义的模板规范,编写模板文件,在模板中定义所需云计算资源的集合及资源间的依赖关系.资源配置细节等,ROS 通过编排引擎自动完成所有资源的创建和

企业级API网关的设计

一.网关简介 1.1 API网关背景介绍 本文讲的是企业级API网关的设计,API Gateway(APIGW / API 网关),顾名思义,是出现在系统边界上的一个面向API的.串行集中式的强管控服务,这里的边界是企业IT系统的边界,主要起到隔离外部访问与内部系统的作用.在微服务概念的流行之前,API网关的实体就已经诞生了,例如银行.证券等领域常见的前置机系统,它也是解决访问认证.报文转换.访问统计等问题的. API网关的流行,源于近几年来,移动应用与企业间互联需求的兴起.移动应用.企业互联,

API网关遇上容器服务

在API经济和微服务的背景下,如何对服务的API进行管理是大家都很感兴趣的话题.本文通过利用阿里云的容器服务和API网关,构建一个完整的基于Docker的具有API管理功能的服务. API管理 假定我们需要这么一个经典的后端服务,访问如下API接口的时候返回Hello World: $ curl http://apisvc.hostxx/api <p>Hello World</p> 这个服务推出后广受欢迎,但是烦恼总是伴随幸福不期而至: 对API进行计费怎么做? 外界访问API的流

实践篇:搭建无服务器应用--函数计算+API网关+云市场(提供手机号归属地查询服务)

6月5日,阿里云的API网关上线了一个新功能,用户定义API后端服务时可以选择使用Function Compute,这样API网关的用户直接使用函数计算的技术能力,这也使得API网关具备可扩展的后端应用,与此同时函数计算也享受到API网关带来的诸多的好处,例如API的请求流量管控.安全鉴权.访问监控.统计等等. 下面我做一个简单的例子,把函数计算+API网关+云市场三者结合起来,提供一个能查询手机号归属地的服务,在这个框架里不需要配置WEB容器.不需要搭建运行环境.不需要购买负载均衡,通过配置和

使用API网关降低API管理成本

       随着企业的发展,开放了大批量的API,用于衔接内部系统,用于链接移动.智能设备,用于链接我们的供应商.代理商和合作伙伴,打通了企业企业的上下游.API承载了企业的关键业务.连接了企业的重要客户,随着API数量的增多,API的管理成本不断提升,从而大大影响了开发效率. 主要体现在: API在不同的不同系统/软件中中开放,无法统一管理,API管理挑战增加,需要统一的API管理: 为了便于用户使用,企业提供API使用文档甚至SDK,占用了大量的时间: 同一功能往往需要开发多个API逻辑来

帮你捋顺 API 网关的 API、SDK和错误排查

API 网关的特殊之处   用户使用 API 网关开放 API 服务,或者调用其他人开放的 API 服务.而且 API 网关自身也开放了管理接口 API.所以用户使用时需要弄清楚两套 API.两套 SDK.两套错误码.这里把这些资源整理一下,方便大家正确使用和问题排查. 开发资源List   APIs   用户在 API 网关开放的 API 服务,如天气查询 API等   API 网关开放的管理接口,用于使用产品,如创建 API等   SDKs   API 网关为天气查询等用户开放的 API 服

第三方账号认证OpenID Connect结合Api网关的应用

什么是OpenID Connect OpenID Connect1.0是一个位于OAuth2.0之上的简单身份认证层,是基于OAuth2.0授权协议基础上的由Google,微软,Facebook等公司于2014年发布的最新的认证授权协议(http://openid.net/specs/openid-connect-core-1_0.html),具有更高的安全性,灵活性,并符合未来安全发展的趋势. OpenID Connect应用 在该协议中,使用令牌(id_token)替换OAuth2的acce

API网关统一管理企业内部API

互联网公司随着业务的发展,公司规模会日益扩张,公司的业务也会越来越丰富,公司内部的部门也会越来越多,不同的业务会有不同的部门来负责,每个部门都有自己的一亩三分地.作为互联网公司,每个部门也或多或少有一些能力对外开放.这些能力都会以API的形式提供给外部.这些API分散在各个部门的服务器上,可能提供的形式.协议.SDK都不一样.公司越大这些API就会变得越来越分散,形态差异越大,一个部门要使用其他部门的API时,需要去每个部门找API相关负责人要来API文档,接口地址及SDK等等,内部协作的效率很

API网关配合智能DNS实现海内外用户就近接入

随着API经济的流行,一些受欢迎的API业务的调用者会越来越多,目前API网关上的Provider基本上只是在离其办公地点近的Region部署一套API,比如驻扎在北京的Provider,只是在阿里云的北京Region部署了一套自己的API,而他的海外用户调用这套API在网络上的耗时就会相对比较多. 目前API网关已经在国内外都部署了多个节点,对于海外用户的就近接入的技术方案创造良好的条件.目前API网关在国内的杭州,北京,上海 ,深圳,青岛,五个Region都部署了节点. API网关在国外的新