申请/专利权人：浪潮云信息技术股份公司

申请日：2021-02-02

公开（公告）日：2024-04-30

公开（公告）号：CN112860551B

主分类号：G06F11/36

分类号：G06F11/36

优先权：

专利状态码：有效-授权

法律状态：2024.04.30#授权;2021.06.15#实质审查的生效;2021.05.28#公开

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

主权项：1.一种基于API网关实现在线调试和文档导出的方法，其特征在于,其实现包括API在线调试和文档导出两个阶段；在API在线调试阶段，通过控制台调试前端页面，同时前端页面对调试过程中用到的参数信息进行校验，并在校验成功后向后端发送请求，后端根据收到的请求校验参数，并对query、header、path位置参数的类型、长度和是否必填进行二次检查，保障入参有效；后端校验参数成功后，进行API的安全认证，并在认证成功后根据认证方式和选择的AKSK调用签名方法生成签名，进而通过RestTemplate创建API网关的调用请求，将响应返回给控制台的前端页面进行展示；后端校验参数失败后，则向前端页面发送失败信息，前端页面调整参数后再次向后端发送请求；在文档导出阶段，通过控制台的前端页面选择一个调试完成的API，点击导出API文档，并将该请求发送至后端，后端首先根据选择的API查询API的元数据信息，随后借助JavaMarkdownGenerator工具类将API元数据渲染成markdown格式，API文档内容渲染完成后以文件输出流的形式随响应下载到本地。

全文数据：

权利要求：

百度查询： 浪潮云信息技术股份公司 一种基于API网关实现在线调试和文档导出的方法

免责声明
1、本报告根据公开、合法渠道获得相关数据和信息，力求客观、公正，但并不保证数据的最终完整性和准确性。
2、报告中的分析和结论仅反映本公司于发布本报告当日的职业理解，仅供参考使用，不能作为本公司承担任何法律责任的依据或者凭证。

阅读全文 双屏查看 官方信息 专利公告 收藏专利 下载PDF 下载WORD