【技术实现步骤摘要】
接口文档生成方法、装置及可读存储介质
本专利技术涉及计算机
，特别是涉及一种接口文档生成方法、装置及可读存储介质。
技术介绍
在服务的开发过程中，通常需要对服务对应的代码进行测试，进行代码测试时需要依据接口文档对服务对应的代码进行测试。目前主要是由开发人员根据编写服务对应的代码时所应用到的类名、方法名、服务名等信息编写接口文档。由于代码中涉及的接口可能为多个，在接口存在多个的情况下，就需要针对每个接口都要编写一个对应的接口文档，因此，人工手动编写接口文档造成人力成本高、耗时长、效率低且容易出错的问题。
技术实现思路
本专利技术实施例提供一种接口文档生成方法、装置及可读存储介质，以解决目前人工手动编写接口文档造成人力成本高、耗时长、效率低且容易出错的问题。本专利技术实施例的第一方面，提供了一种接口文档生成方法，包括：获取第一目标服务的数据包，其中，所述数据包包括所述第一目标服务的所有接口对应的类文件，一个所述类文件中包括至少一个所述接口；解析各所述类文件，以获得各所述类...
【技术保护点】
1.一种接口文档生成方法，其特征在于，执行于服务器，包括：/n获取第一目标服务的数据包，其中，所述数据包包括所述第一目标服务的所有接口对应的类文件，一个所述类文件中包括至少一个所述接口；/n解析各所述类文件，以获得各所述类文件中包括的所述至少一个所述接口的接口代码；/n对各所述类文件中包括的所述接口代码提取接口类信息，以根据所述接口类信息生成所述第一目标服务的各所述接口对应的第一接口文档。/n
【技术特征摘要】
1.一种接口文档生成方法，其特征在于，执行于服务器，包括：
获取第一目标服务的数据包，其中，所述数据包包括所述第一目标服务的所有接口对应的类文件，一个所述类文件中包括至少一个所述接口；
解析各所述类文件，以获得各所述类文件中包括的所述至少一个所述接口的接口代码；
对各所述类文件中包括的所述接口代码提取接口类信息，以根据所述接口类信息生成所述第一目标服务的各所述接口对应的第一接口文档。
2.根据权利要求1所述的方法，其特征在于，所述接口类信息包括类名、方法名、第一目标服务标识、所述方法名对应的方法的输入参数、所述方法的返回参数、第一版本标识、以及与所述第一目标服务标识和所述第一版本标识都对应的端口标识和地址标识，第一版本标识为所述第一目标服务的第一版本的标识。
3.根据权利要求2所述的方法，其特征在于，在所述对各所述类文件中包括的所述接口代码提取接口类信息，以根据所述接口类信息生成所述第一目标服务的各所述接口对应的第一接口文档之后，还包括：
将与所述第一目标服务标识、所述第一版本标识、以及所述接口的接口标识都关联的所述第一接口文档存储在数据库中。
4.根据权利要求3所述的方法，其特征在于，在所述将与所述第一目标服务标识、所述第一版本标识、以及所述接口的接口标识都关联的所述第一接口文档存储在数据库中之后，还包括：
每间隔预设时间对代码服务器上存储的所述第一目标服务的数据包进行扫描，以根据所述数据包对应的时间信息，判断所述数据包是否发生更新；
在确定所述数据包发生更新的情况下，从所述代码服务器获取更新后的数据包；
对所述更新后的数据包进行分析，以确定目标接口，其中，所述目标接口包括所述更新后的数据包中的新增类文件对应的接口和/或所述更新后的数据包中发生变更的原类文件对应的接口；
对所述目标接口的接口代码提取接口类信息，以根据目标接口的接口代码对应的接口类信息生成与所述目标接口对应的第二接口文档；
将与所述第一目标服务标识、所述第一版本标识、以及所述目标接口的接口标识都关联的所述第二接口文档存储在所述数据库中。
5.根据权利要求1-4任一所述的方法，其特征在于，在所述获取第一目标服务的数据包之前，还包括：
接收终端发送的请求消息，其中，所述请求消息中包括所述第一目标服务的第一目标服务标识、所述第一目标服务的所述第一版本标识、以及与所述第一目标服务标识和所述第一版本标识都对应的存储地址；
所述获取第一目标服务的数据包，包括：
从代码服务器的所述存储地址，获取与所述第一目标服务标识和所述第一版本标识都对应的所述第一目标服务的数据包。
6.根据权利要求5所述的方法，其特征在于，还包括：
接收终端发送的页面请求；
响应于所述页面请求，从所述数据库中获取至少一个服务的服务标识、与所...
【专利技术属性】
技术研发人员：秦偲晟，朱传波，杨少华，陶静煜，胡陈晨，
申请(专利权)人：瑞庭网络技术上海有限公司，
类型：发明
国别省市：上海;31
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。