预览加载中,请您耐心等待几秒...
1/10
2/10
3/10
4/10
5/10
6/10
7/10
8/10
9/10
10/10

亲,该文档总共17页,到这已经超出免费预览范围,如果喜欢就直接下载吧~

如果您无法下载资料,请参考说明:

1、部分资料下载需要金币,请确保您的账户上有足够的金币

2、已购买过的文档,再次下载不重复扣费

3、资料包下载后请先用软件解压,在使用对应软件打开

(19)中华人民共和国国家知识产权局(12)发明专利申请(10)申请公布号CN109032663A(43)申请公布日2018.12.18(21)申请号201810746699.4(22)申请日2018.07.09(71)申请人深圳市小牛在线互联网信息咨询有限公司地址518000广东省深圳市南山区南山街道高新园高新南一道富诚科技大厦四楼(72)发明人胡山泉刘清有张翼(74)专利代理机构深圳市精英专利事务所44242代理人林燕云(51)Int.Cl.G06F8/73(2018.01)G06F17/24(2006.01)权利要求书2页说明书10页附图4页(54)发明名称接口文档的生成方法、装置、计算机设备及存储介质(57)摘要本发明公开了一种接口文档的生成方法、装置、计算机设备及存储介质,该方法包括:获取系统分类名对应的代码文件;扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息以及所述代码文件中的实体类以获取所述实体类的注释信息;根据所述接口调用信息和注释信息生成接口记录信息;获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息;基于所述接口记录信息,根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表,以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表;根据所述入参信息记录表和返回信息记录表生成接口文档。由此方便了前后端的开发人员的沟通,提高了软件系统的开发效率。CN109032663ACN109032663A权利要求书1/2页1.一种接口文档的生成方法,其特征在于,包括:获取系统分类名对应的代码文件,所述代码文件包括Controller接口和实体类,所述Controller接口和实体类均包括预设的注释信息;扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息,以及扫描所述代码文件中的实体类以获取所述实体类的注释信息;根据所述接口调用信息和注释信息生成接口记录信息;获取所述Controller接口的入参信息以及响应于所述入参信息的返回信息;基于所述接口记录信息,根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表,以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表;根据所述入参信息记录表和返回信息记录表生成接口文档。2.根据权利要求1所述的接口文档的生成方法,其特征在于,所述扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息,扫描所述代码文件中的实体类以获取所述实体类的注释信息,包括:根据第一预设关键字扫描所述代码文件中的Controller接口以获取所述Controller接口的接口调用信息和注释信息;以及根据第二预设关键字扫描所述代码文件中的实体类以获取所述实体类的注释信息。3.根据权利要求1所述的接口文档的生成方法,其特征在于,在所述获取系统分类名对应的代码文件之前,还包括:接收终端发送的文档生成指令,所述文档生成指令为所述终端根据用户输入的系统分类名而生成的指令。4.根据权利要求1所述的接口文档的生成方法,其特征在于,所述接口调用信息包括URL链接地址;所述基于所述接口记录信息,根据所述Controller接口的入参信息和所述实体类的注释信息生成入参信息记录表,以及根据所述返回信息和所述实体类的注释信息生成返回信息记录表,包括:基于所述URL链接地址,根据所述Controller接口的注释信息、入参信息和所述实体类的注释信息生成与所述URL链接地址对应的入参信息记录表,以及根据所述返回信息和所述实体类的注释信息生成与所述URL链接地址对应的返回信息记录表。5.根据权利要求4所述的接口文档的生成方法,其特征在于,在所述根据所述入参信息记录表和返回信息记录表生成接口文档之后,还包括:接收接口调试指令,所述接口调试指令包括系统分类名;根据所述系统分类名查找对应的接口文档,根据查找到的接口文档获取相应的URL链接地址;将所述URL链接地址和所述接口文档发送至终端,使得所述终端显示所述URL链接地址以及用户选中的URL链接地址对应的入参信息记录表和返回信息记录表以便所述用户进行接口调试。6.根据权利要求5所述的接口文档的生成方法,其特征在于,所述将所述URL链接地址和所述接口文档发送至终端之后,还包括:接收所述终端反馈的调试结果信息,所述调试结果信息包括标签信息;2CN109032663A权利要求书2/2页根据所述调试结果信息更新所述接口文档,并根据所述标签信息对更新后的接口文档进行标记。7.根据权利要求1所述的接口文档的生成方法,其特征在于,在所述根据所述入参信息记录表和返回信