接口文档的生成方法和装置制造方法及图纸

技术编号:20484468 阅读:63 留言:0更新日期:2019-03-02 18:48
本申请提供了一种接口文档的生成方法和装置,该方法包括:获取目标项目的测试脚本,该测试脚本用于测试该目标项目中的目标接口;对该目标项目的测试脚本进行解析,得到该目标接口的接口信息,该接口信息包括:接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息;将该目标接口的接口信息存储在内存中的对象列表中;将该对象列表中的该目标接口的接口信息填充到预定义的接口文档模板中,以生成该目标接口的接口文档。采用本申请的接口文档的生成方法,能够根据接口的测试脚本自动生成接口文档,从而提高工作效率。

【技术实现步骤摘要】
接口文档的生成方法和装置
本申请涉及测试
,并且更具体地,涉及测试
中接口文档的生成方法和装置。
技术介绍
接口,即应用程序编程接口(applicationprogramminginterface,API)。通常由开发人员完成软件开发,并由测试人员通过接口测试脚本对接口进行测试。为响应快速变化,开发人员和测试人员之间大多采用重沟通、轻文档的敏捷模式。由于对敏捷的理解不尽相同,甚至有的公司没有接口文档。测试人员和开发人员靠不断的沟通和确认才能完成接口测试工作。有的公司虽然有接口文档,但接口变动后文档经常不更新,以至于实际提测的接口和接口文档的定义不一致,最后还是需要测试人员和开发人员反复的沟通和确认,由于需要耗费大量的沟通成本,因此,工作效率较低。此外,现有技术中,Swagger是一款根据软件开发人员在代码中的标注注解生成接口文档的工具,开发过程中也需要耗费大量的人力资源,因此,工作效率较低。
技术实现思路
本申请提供一种接口文档的生成方法和装置,能够根据接口的测试脚本自动生成接口文档,从而提高工作效率。为实现上述目的,本申请提供一种接口文档的生成方法,包括以下内容:获取目标项本文档来自技高网...

【技术保护点】
1.一种接口文档的生成方法,其特征在于,包括:获取目标项目的测试脚本,所述测试脚本用于测试所述目标项目中的目标接口;对所述目标项目的测试脚本进行解析,得到所述目标接口的接口信息,所述接口信息包括:接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息;将所述目标接口的接口信息存储在内存中的对象列表中;将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中,以生成所述目标接口的接口文档。

【技术特征摘要】
1.一种接口文档的生成方法,其特征在于,包括:获取目标项目的测试脚本,所述测试脚本用于测试所述目标项目中的目标接口;对所述目标项目的测试脚本进行解析,得到所述目标接口的接口信息,所述接口信息包括:接口名称、接口地址、资源路径、请求方式、头信息、内容类型、请求参数的定义、响应报文的定义中的多项信息;将所述目标接口的接口信息存储在内存中的对象列表中;将所述对象列表中的所述目标接口的接口信息填充到预定义的接口文档模板中,以生成所述目标接口的接口文档。2.根据权利要求1所述的方法,其特征在于,所述目标接口包括至少一个接口,所述目标项目的测试脚本包括所述至少一个接口中每个接口的测试脚本,所述对象列表包括至少一个对象,所述至少一个对象与所述至少一个接口的接口信息一一对应。3.根据权利要求2所述的方法,其特征在于,在将所述目标接口的接口信息存储在内存中的对象列表中之后,所述方法还包括:将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下,所述数据库中的所述目标项目下包括至少一个记录,所述至少一个记录与所述至少一个对象一一对应。4.根据权利要求3所述的方法,其特征在于,在将所述至少一个对象中的每个对象按照预先定义的数据存储对象存储至数据库中的所述目标项目下之后,所述方法还包括:获取脚本请求,所述脚本请求携带所述目标项目的标识;根据所述目标项目的标识,获取所述数据库中所述目标项目下存储的所述至少一个记录;将所述至少一个记录加载到所述内存中,得到所述对象列表,所述对象列表中包括所述至少一个接口中每个接口的接口信息;将所述每个接口的接口信息填充到所述预定义的接口文档模板中,以生成所述每个接口的接口文档。5.根据权利要求1至4中任一项所述的方法,其特征在于,在对所述目标项目的测试脚本进行解析,得到所述目标接口的接口信息之前,所述方法还包括:根据所述目...

【专利技术属性】
技术研发人员:瞿庆徐志成
申请(专利权)人:深圳壹账通智能科技有限公司
类型:发明
国别省市:广东,44

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1