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

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

目录
相关文章
|
1月前
|
API
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
阿里云微服务引擎及 API 网关 2024 年 2 月产品动态
|
2月前
|
Prometheus 网络协议 JavaScript
api 网关 kong 数据库记录请求响应报文
Kong的tcp-log-with-body插件是一个高效的工具,它能够转发Kong处理的请求和响应。这个插件非常适用于需要详细记录API请求和响应信息的情景,尤其是在调试和排查问题时。
48 0
api 网关 kong 数据库记录请求响应报文
|
2月前
|
监控 应用服务中间件 API
API 网关的功能用途及实现方式
API 网关的功能用途及实现方式
|
5月前
|
Java API Maven
淘东电商项目(05) - Swagger及网关统一管理API
淘东电商项目(05) - Swagger及网关统一管理API
72 0
|
7天前
|
API
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态
阿里云微服务引擎及 API 网关 2024 年 3 月产品动态。
|
1月前
|
运维 Cloud Native 应用服务中间件
阿里云微服务引擎 MSE 及 API 网关 2024 年 02 月产品动态
阿里云微服务引擎 MSE 面向业界主流开源微服务项目, 提供注册配置中心和分布式协调(原生支持 Nacos/ZooKeeper/Eureka )、云原生网关(原生支持Higress/Nginx/Envoy,遵循Ingress标准)、微服务治理(原生支持 Spring Cloud/Dubbo/Sentinel,遵循 OpenSergo 服务治理规范)能力。API 网关 (API Gateway),提供 APl 托管服务,覆盖设计、开发、测试、发布、售卖、运维监测、安全管控、下线等 API 生命周期阶段。帮助您快速构建以 API 为核心的系统架构.满足新技术引入、系统集成、业务中台等诸多场景需要。
|
5月前
|
API
怎么找到合适的方法进行API接口调试
怎么找到合适的方法进行API接口调试
|
3月前
|
人工智能 监控 安全
百万并发,API 网关抗住了亚运会流量高峰
本文主要介绍作为亚运会所有核心流量的入口,阿里云推出了一款百万并发规格的 API 网关,抗住了亚运会流量高峰,为亚运会提供强大的技术支持。
|
3月前
|
监控 前端开发 测试技术
活久见:都 2203 年了,你还在使用 word 调试 API
活久见:都 2203 年了,你还在使用 word 调试 API
|
4月前
|
缓存 JavaScript Java
使用 API 网关
使用 API 网关
58 0