[发明专利]一种基于API网关实现在线调试和文档导出的方法

说明书

本发明公开一种基于API网关实现在线调试和文档导出的方法，涉及API网关技术领域，包括API在线调试和文档导出两个阶段；在API在线调试阶段，通过控制台调试前端页面，并向后端发送调试用到的参数信息，后端校验参数后，进行API的安全认证，并在认证成功后生成签名，进而通过RestTemplate创建API网关的调用请求，将响应返回给控制台的前端页面进行展示；在文档导出阶段，通过控制台的前端页面选择一个调试完成的API，借助Java Markdown Generator工具类将API元数据渲染成markdown格式，随后以文件输出流的形式随响应下载到本地。本发明可以省去使用工具调试API填写参数以及生成签名所需要的工作，提高接口调试效率和文档维护成本。

技术领域

本发明涉及API网关技术领域，具体的说是一种基于API网关实现在线调试和文档导出的方法。

背景技术

随着云计算、人工智能和大数据行业的快速发展，越来越多的应用程序接口通过API网关技术开放给互联网开发者调用，开放后端能力，将自身优势转化为经济价值。

正常情况下，在发布一个API后，开发者会使用Postman或Jmeter工具测试API能否正常调用，对于入参比较多的API，在手工填写入参时很有可能会遗漏某些参数或者参数的位置填写错误，而且某些安全认证的API在调用之前需要通过SDK生成签名信息，然后将签名信息放到指定参数位置，这将导致API在调用之前的准备工作非常繁琐，而且容易出错。另外，托管的API后期可能会对基本信息进行维护，这样就会和最初的接口文档不一致，每次变更API都需要同时维护接口文档。

为了解决这一弊端，提高接口调试效率，涉及研发一种基于API网关实现在线调试和文档导出的方法。

发明内容

本发明针对目前技术发展的需求和不足之处，提供一种基于API网关实现在线调试和文档导出的方法，旨在省去使用工具调试API填写参数以及生成签名所需要的工作，提高接口调试效率和文档维护成本。

本发明的一种基于API网关实现在线调试和文档导出的方法，解决上述技术问题采用的技术方案如下：

一种基于API网关实现在线调试和文档导出的方法，其实现包括API在线调试和文档导出两个阶段；

在API在线调试阶段，通过控制台调试前端页面，并向后端发送调试用到的参数信息，后端校验参数后，进行API的安全认证，并在认证成功后生成签名，进而通过RestTemplate创建API网关的调用请求，将响应返回给控制台的前端页面进行展示；

在文档导出阶段，通过控制台的前端页面选择一个调试完成的API，借助JavaMarkdown Generator工具类将API元数据渲染成markdown格式，并下载API文档到本地。

进一步的，在API在线调试阶段，通过控制台调试前端页面时，前端页面对调试过程中用到的参数信息进行校验，并在校验成功后向后端发送请求。

更进一步的，在API在线调试阶段，后端根据收到的请求校验参数，同时，还对query、header、path位置参数的类型、长度和是否必填进行二次检查，保障入参有效。

进一步的，在API在线调试阶段，后端校验参数成功后，进行API的安全认证，并在认证成功后根据认证方式和选择的AKSK调用签名方法生成签名。

更进一步的，在API在线调试阶段，后端校验参数失败后，向前端页面发送失败信息，前端页面调整参数后再次向后端发送请求。

进一步的，RestTemplate是Spring用于同步client端的核心类，其满足RestFul原则，在默认情况下，RestTemplate依赖jdk的HTTP连接工具。