基于网关的开放平台应用程序接口在线调试系统及方法与流程

1.本发明涉及互联网技术领域，具体涉及一种基于网关的开放平台应用程序接口在线调试系统及方法。


背景技术：

2.随着互联网的不断发展，在当下互联网时代，把一系列服务封装为数据接口开放出去的技术性开放已成为各大互联网公司的未来战略，开放自己的的技术服务能力，从中转换获得经济价值。各个互联网巨头将自己的技术开放出去，供第三方开发者使用；第三方开发者基于这些开放的api能力来实现自己的业务，开发出不同的应用。
3.如申请号为cn202010332019.1的发明申请中公开了一种应用程序编程接口api调试方法以及调试终端，其中方法包括：向目标应用程序发送通信请求，其中，通信请求包含第一应用程序编程接口的信息和第一应用程序编程接口对应的目标参数值；接收目标应用程序根据通信请求获得的反馈结果，其中，反馈结果为目标应用程序根据通信请求所包含的第一应用程序编程接口的信息和第一应用程序编程接口对应的目标参数值执行第一应用程序编程接口所获得的反馈结果；在反馈结果与目标参数值对应的预期结果相匹配的情况下，确定多个应用程序中每个应用程序所调用的第一应用程序编程接口调试成功。
4.上述方法可以实现api的调试，但是，通常来说，开发者调试api时需要自己用响应的工具或者以代码的形式进行api的调用和调试，但是如果api调试所需的参数较多，则人工成本过高，且有较大可能的出错性。


技术实现要素：

5.针对现有技术存在的上述不足，本发明要解决的技术问题是：如何提供一种能够减少api调试时开发者的介入程度，从而降低出错率，提高开发效率，同时能够实现开放平台的api在线调试目的的基于网关的开放平台应用程序接口在线调试系统及方法。
6.为了解决上述技术问题，本发明采用如下技术方案：基于网关的开放平台应用程序接口在线调试系统，包括在线调试模块、接口文档管理模块、签名计算引擎模块和应用程序接口网关；所述接口文档管理模块与所述在线调试模块双向通信连接，用于存储应用程序接口的文档数据，并在接收到所述在线调试模块的请求后发送应用程序接口的文档数据到所述在线调试模块；所述签名计算引擎模块与所述在线调试模块双向通信连接，用于对应用程序接口调试所需的参数进行计算并生成认证参数发送到所述在线调试模块；所述在线调试模块与所述应用程序接口网关双向通信连接，用于根据接收到的应用程序接口的文档数据渲染生成在线调试界面并提供相应的后台功能，并根据在线调试界面的参数构建出相应的应用程序请求发送到所述应用程序接口网关；所述应用程序接口网关接收并验证来自于所述在线调试模块的应用程序请求，同
时向所述在线调试模块返回验证结果。
7.一种基于网关的开放平台应用程序接口在线调试方法，采用上述的基于网关的开放平台应用程序接口在线调试系统，包括以下步骤：步骤1）所述在线调试模块向所述接口文档管理模块发送获取应用程序接口的文档数据的请求；步骤2）所述接口文档管理模块接收到所述在线调试模块的请求后发送应用程序接口的文档数据到所述在线调试模块；步骤3）所述在线调试模块根据接收到的应用程序接口的文档数据渲染生成在线调试界面；步骤4）进行在线调试界面参数的输入；步骤5）所述在线调试模块向所述签名计算引擎模块发送认证参数的计算请求；步骤6）所述签名计算引擎模块根据在线调试界面的参数计算生成认证参数并返回给所述在线调试模块的在线调试界面；步骤7）所述在线调试模块根据在线调试界面参数和认证参数构建出相应的应用程序请求并发送给所述应用程序接口网关；步骤8）所述应用程序接口网关对来自于所述在线调试模块的应用程序请求中的参数进行安全校验；步骤9）所述应用程序接口网关对来自于所述在线调试模块的应用程序请求中的参数的安全校验是否通过，若是则执行步骤10），若否则执行步骤11）；步骤10）返回校验通过后的正常响应到所述在线调试模块后结束；步骤11）返回校验不通过的错误信息到所述在线调试模块后结束。
8.优选的，步骤3）中，所述在线调试模块渲染生成的在线调试界面上设有应用程序的选择框，当通过应用程序的选择框选择不同的应用程序时，所述在线调试模块渲染生成与该应用程序相对应的在线调试界面。
9.优选的，步骤7）中，所述在线调试模块根据在线调试界面参数和认证参数构建出相应的应用程序的http请求发送给所述应用程序接口网关。
10.优选的，步骤8）中，所述应用程序接口网关接收到所述在线调试模块的http请求后，从http请求中取出标头里的参数进行安全校验。
11.优选的，步骤8）中，安全校验包括对标头里的标识参数的有效性、时间戳的正确性、以及验证参数的正确性的验证。
12.优选的，步骤8）中，所述应用程序接口网关对来自于所述在线调试模块的应用程序请求中的参数进行安全校验时还对应用程序请求中的参数进行转换。
13.优选的，步骤10）中，校验通过后，所述应用程序接口网关根据路由规则讲转换后的参数请求到路由后的地址，并将路由后的地址的响应结果返回给所述在线调试模块。
14.一种存储介质，所述存储介质存储有一个或者多个程序，所述一个或者多个程序被处理器运行时，执行上述的基于网关的开放平台应用程序接口在线调试方法。
15.与现有技术相比，本发明具有以下优点：1、本发明通过接口文档管理模块存储应用程序接口的文档数据，并通过在线调试模块提供应用程序接口（api）的在线调试界面，同时在线调试模块能够根据选择的不同应
用程序对在线调试界面进行渲染，在线调试界面包括该应用程序调试需要的参数信息，开发者只需要在根据在线调试界面的参数信息填入相应的参数即可，由此减少人工介入，降低出错率，并且大幅度提高了api调试与软件开发的效率。
16.2、本发明基于网关的方式，能对api调试进行很好的管控，如通过网关限制入口的流量；通过网关直接关闭应用程序接口，实现熔断的效果等。
17.3、本方案通过签名计算引擎模块，对api调试所需的参数直接进行计算生成认证参数，无须开发者自己进行计算，开发者可在进行在线调试的同时，也可更加直观的看到具体验证参数计算的方法与过程，可更好更轻松的进行后续的相关代码的开发，大幅提高软件开发效率。
18.4、本方案通过在线调试模块提供可用的前端在线调试界面和响应的后台服务，并通过应用程序接口网关来实现开放平台的应用程序接口的在线调试目的。
附图说明
19.图1为本发明基于网关的开放平台应用程序接口在线调试系统的系统构架图；图2为本发明基于网关的开放平台应用程序接口在线调试方法的整体流程图；图3为本发明基于网关的开放平台应用程序接口在线调试方法中在线调试界面的界面图；图4为本发明基于网关的开放平台应用程序接口在线调试方法中签名计算引擎模块的签名计算过程界面图。
具体实施方式
20.下面将结合附图及实施例对本发明作进一步说明。
21.如附图1所示，基于网关的开放平台应用程序接口在线调试系统，包括在线调试模块、接口文档管理模块、签名计算引擎模块和应用程序接口网关（api网关）；接口文档管理模块与在线调试模块双向通信连接，用于存储应用程序接口的文档数据，并在接收到在线调试模块的请求后发送应用程序接口的文档数据到在线调试模块；签名计算引擎模块与在线调试模块双向通信连接，用于对应用程序接口调试所需的参数进行计算并生成认证参数发送到在线调试模块；在线调试模块与应用程序接口网关双向通信连接，用于根据接收到的应用程序接口的文档数据渲染生成在线调试界面并提供相应的后台功能，并根据在线调试界面的参数构建出相应的应用程序请求发送到应用程序接口网关；应用程序接口网关接收并验证来自于在线调试模块的应用程序请求，同时向在线调试模块返回验证结果。
22.如附图2所示，一种基于网关的开放平台应用程序接口在线调试方法，采用上述的基于网关的开放平台应用程序接口在线调试系统，包括以下步骤：步骤1）在线调试模块向接口文档管理模块发送获取应用程序接口（api）的文档数据的请求。具体的，在线调试模块通过向接口文档管理模块发起http请求来获取api的文档数据。
23.步骤2）接口文档管理模块接收到在线调试模块的请求后发送应用程序接口（api）
的文档数据到在线调试模块；步骤3）在线调试模块根据接收到的应用程序接口的文档数据渲染生成在线调试界面。具体的，在线调试模块的前端会基于接收到的api的文档数据，进行在线调试界面的渲染，会把api的文档数据中的所有参数都展示在线调试界面上，以便开发者填写。同时，如附图3所示，在线调试界面支持开发者自己选择需要进行调试的应用程序，应用程序内涵盖应用key（appkey）以及应用id（appid）等重要参数。在线调试界面中会渲染出应用程序的信息以及调试的api相应的信息，包含请求的url地址、请求方式以及content-type等。同时，根据从接口文档管理模块中获取的api的文档数据，会渲染出所需填写的参数。参数会按http请求报文的不同部分来展示，包含header参数、body参数等。
24.步骤4）进行在线调试界面参数的输入；步骤5）在线调试模块向签名计算引擎模块发送认证参数的计算请求。具体的，开放平台的api都需要一个公共的认证参数，即authorization（签名）。每次api调用都需要传入此签名参数。在开发者填写完请求所需的响应参数后，签名计算引擎模块会自动将参数组合起来，按照一定的签名算法，进行签名authorization的计算，此过程完全由后台的签名计算引擎模块完成，无须开发者自己进行计算，具体的签名计算过程如附图4所示。开发者可在进行在线调试的同时，也可更加直观的看到具体签名计算的方法与过程，可更好更轻松的进行后续的相关代码的开发。
25.步骤6）签名计算引擎模块根据在线调试界面的参数计算生成认证参数并返回给在线调试模块的在线调试界面；步骤7）在线调试模块根据在线调试界面参数和认证参数构建出相应的应用程序请求并发送给应用程序接口网关。在线调试模块根据在线调试界面参数和认证参数构建出相应的应用程序的http请求发送给应用程序接口网关。具体的，在开发者完成参数的填写以及签名计算引擎模块计算完成调试所需的认证参数后，可直接通过在线调试页面进行http请求的发起。在在线调试页面上点击“发送请求”按钮后，在线调试模块会构建一个http请求，其中请求的地址为所调试的api的地址，并会将所有页面上的参数分别放置到http请求的header（标头）、body（主体）以及query中，然后发起的http请求会发送到应用程序接口网关。
26.步骤8）应用程序接口网关对来自于在线调试模块的应用程序请求中的参数进行安全校验。应用程序接口网关接收到在线调试模块的http请求后，从http请求中取出标头里的参数进行安全校验；安全校验包括对标头里的标识参数的有效性、时间戳的正确性、以及验证参数的正确性的验证；应用程序接口网关对来自于在线调试模块的应用程序请求中的参数进行安全校验时还对应用程序请求中的参数进行转换。具体的，应用程序接口网关首先会从收到的http请求中，取出header里的参数，进行安全校验，校验token参数（标识参数）的有效性，校验时间戳的正确性，校验签名参数的正确性；应用程序接口网关在校验参数的同时，也会进行参数转换。
27.步骤9）应用程序接口网关对来自于在线调试模块的应用程序请求中的参数的安全校验是否通过，若是则执行步骤10），若否则执行步骤11）；步骤10）返回校验通过后的正常响应到在线调试模块后结束；步骤11）返回校验不通过的错误信息到在线调试模块后结束。
28.在本实施例中，步骤3）中，在线调试模块渲染生成的在线调试界面上设有应用程序的选择框，当通过应用程序的选择框选择不同的应用程序时，在线调试模块渲染生成与该应用程序相对应的在线调试界面。
29.在本实施例中，步骤10）中，校验通过后，应用程序接口网关根据路由规则讲转换后的参数请求到路由后的地址，并将路由后的地址的响应结果返回给在线调试模块。
30.在本实施例中还提供一种存储介质，存储介质存储有一个或者多个程序，一个或者多个程序被处理器运行时，执行上述的基于网关的开放平台应用程序接口在线调试方法。
31.与现有技术相比，本发明通过接口文档管理模块存储应用程序接口的文档数据，并通过在线调试模块提供应用程序接口（api）的在线调试界面，同时在线调试模块能够根据选择的不同应用程序对在线调试界面进行渲染，在线调试界面包括该应用程序调试需要的参数信息，开发者只需要在根据在线调试界面的参数信息填入相应的参数即可，由此减少人工介入，并且大幅度提高了api调试与软件开发的效率。本发明基于网关的方式，能对api调试进行很好的管控，如通过网关限制入口的流量；通过网关直接关闭应用程序接口，实现熔断的效果等。本方案通过签名计算引擎模块，对api调试所需的参数直接进行计算生成认证参数，无须开发者自己进行计算，开发者可在进行在线调试的同时，也可更加直观的看到具体验证参数计算的方法与过程，可更好更轻松的进行后续的相关代码的开发，大幅提高软件开发效率。本方案通过在线调试模块提供可用的前端在线调试界面和响应的后台服务，并通过应用程序接口网关来实现开放平台的应用程序接口的在线调试目的。
32.最后需要说明的是，以上实施例仅用以说明本发明的技术方案而非限制技术方案，本领域的普通技术人员应当理解，那些对本发明的技术方案进行修改或者等同替换，而不脱离本技术方案的宗旨和范围，均应涵盖在本发明的权利要求范围当中。