[发明专利]接口文档自动生成方法、系统、终端及存储介质在审
申请号: | 202011073606.X | 申请日: | 2020-10-09 |
公开(公告)号: | CN112199331A | 公开(公告)日: | 2021-01-08 |
发明(设计)人: | 吕宪伟 | 申请(专利权)人: | 平安科技(深圳)有限公司 |
主分类号: | G06F16/11 | 分类号: | G06F16/11;G06F16/16;G06F8/35;G06F8/41 |
代理公司: | 深圳国新南方知识产权代理有限公司 44374 | 代理人: | 周雷 |
地址: | 518000 广东省深圳市福田区福*** | 国省代码: | 广东;44 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 接口 文档 自动 生成 方法 系统 终端 存储 介质 | ||
本发明公开了一种接口文档自动生成方法、系统、终端及存储介质,其中方法包括:接收接口文档生成请求,接口文档生成请求包括至少一个项目信息;从至少一个项目信息中提取出每个项目的接口信息;从接口信息中分析出每个接口对应的域名信息;利用接口信息生成接口文档;将域名信息相同的接口文档进行聚合再输出。通过上述方式,本发明能够批量处理项目的接口信息,自动生成每个接口的Swagger规范的接口文档,且还能够对接口文档按照域名进行聚合,方便用户快速查看。
技术领域
本申请涉及计算机技术领域,特别是涉及一种接口文档自动生成方法、系统、终端及存储介质。
背景技术
在当今互联网时代,信息系统支撑着线上服务的运转,信息系统内部的前端服务和后台服务之间以及信息系统之间的交互,都是通过API(Application ProgrammingInterface,应用程序接口)进行通信的,而互联网公司服务器开放给客户端的接口往往非常多,公司内部对于此类接口的文档却往往少之又少,造成内部学习交流成本被提高。
目前,接口文档生成主要通过两种方式,一种是人工书写接口文档,一种是借助自动化接口文档生成工具。
第一种方式下服务接口文档是由人工手动编写,按照接口定义,人工提取接口信息,人工梳理数据关系,然后根据接口定义信息,一个一个字段提取出来写在文档上面。每个字段都需要在文档中注明字段名称、字段类型、字段是否可以为空、字段的默认值、字段的示例值、字段的描述等。另外字段有基本数据类型和复杂结构体之分,复杂结构体可能有多层嵌套,深度可能多达数层。接口文档还需要包含每个接口的错误码。当接口数量较多时,这种纯机械式手工服务文档编写效率低下且容易出错,准确性无法保证。此外,服务接口变更时,由于没有人工及时对服务接口文档更新而造成服务异常的情况也是经常发生。
对于第二种方式,现有的文档生成工具不适用于批量处理项目接口的情况,即使能够处理,其生成的接口文档混杂在一起,仍然需要人工确认后进行一一归类,同样需要耗费大量时间,效率低下且不利于对接口文档的管理。
发明内容
本申请提供一种接口文档自动生成方法、系统、终端及存储介质,以解决现有接口文档生成方式效率低下、不利于管理的问题。
为解决上述技术问题,本申请采用的一个技术方案是:提供一种接口文档自动生成方法,包括:接收接口文档生成请求,接口文档生成请求包括至少一个项目信息;从至少一个项目信息中提取出每个项目的接口信息;从接口信息中分析出每个接口对应的域名信息;利用接口信息生成接口文档;将域名信息相同的接口文档进行聚合再输出。
作为本申请的进一步改进,从至少一个项目中提取出每个项目的接口信息,包括:将至少一个项目的接口信息统一导入至postman的一个collection中;导出collection得到一个JSON格式文件,再对JSON格式文件进行解析,得到每个项目的接口信息。
作为本申请的进一步改进,利用接口信息生成接口文档,包括:分析接口信息并从接口信息中提取项目名称信息息;根据项目名称信息创建存储文件夹,每个项目的所有接口对应一个存储文件夹;利用接口信息和Swagger规范生成每个接口对应的接口文档;基于项目名称信息将接口文档存储至对应的存储文件夹。
作为本申请的进一步改进,利用接口信息和Swagger规范生成每个接口对应的接口文档,包括:将接口信息按照预设规则自动转换为Swagger规范规定格式的参数;将参数填充至预先准备好的文档模板中,得到每个接口对应的接口文档。
作为本申请的进一步改进,将接口信息按照预设规则自动转换为Swagger规范规定格式的参数之后,还包括:判断每个接口对应的参数中是否包括认证参数;若不包括,则将接口的认证参数设置为默认值并补全至参数中。
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于平安科技(深圳)有限公司,未经平安科技(深圳)有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/202011073606.X/2.html,转载请声明来源钻瓜专利网。
- 上一篇:一种电子烟控制系统及控制方法
- 下一篇:一种耐振、耐倾斜摇摆船用水质检验装置