一种快速验证应用程序接口的装置及其控制方法与流程

1.本发明属于计算机应用技术领域，尤其涉及一种快速验证应用程序接口的装置及其控制方法。


背景技术：

2.目前，作为互联网行业技术开发者来说，应用程序接口的调试是必不可少的一个工作环节。对于接口的管理，目前行业大部分采取的解决方案有使用swagger管理接口文档、使用postman调试接口、使用easymock等其他mock工具来进行模拟数据。这样的接口管理方式，需要维护不同的工具，并且工具之间数据的一致性非常困难、非常低效。这里不仅仅是工作量的问题，更大的问题是多个系统之间数据不一致，导致协作低效，频繁出现问题，造成不必要的损失。
3.应用程序接口(application programming interface，api)是一些预先定义的接口(如函数、http接口)，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。
4.由于近年来软件的规模日益庞大，常常需要把复杂的系统划分成小的组成部分，应用程序接口的设计与对接就显得十分重要。在一个项目中，往往需要大量的应用程序接口通信与对接，对接前的验证工作也比较繁琐耗时，所以就需要一个装置能够快速验证接口是否有效。
5.目前程序开发中，需要大量的应用程序接口对接工作，需要具体开发到业务时，依次验证每个接口是否有效输出，依次验证接口需要消耗不必要的人力和时间。
6.程序开发过程中，一个应用程序接口一般只负责一个具体功能点，每个功能之间相互是解耦的，需要开发人员实现到具体业务时才会使用到具体应用程序接口，每次使用到接口时才会验证接口是否有效，然后反馈到对应开发人员，这中间往往需要大量时间成本和沟通成本，消耗不必要的人力和时间。
7.通过上述分析，现有技术存在的问题及缺陷为：
8.工具之间数据的一致性非常困难、非常低效。
9.多个系统之间数据不一致，导致协作低效，频繁出现问题，造成不必要的损失。
10.程序开发过程中，每次使用到接口时才会验证接口是否有效，然后反馈到对应开发人员，需要大量时间成本和沟通成本，消耗不必要的人力和时间。


技术实现要素：

11.针对现有技术存在的问题，本发明提供了一种快速验证应用程序接口的装置及其控制方法。
12.本发明是这样实现的，一种快速验证应用程序接口的装置的控制方法包括：
13.步骤一，支持导入或者手动录入遵循openapi3.0(原swagger)、json schema规范
的文件。通过读取该文件json内容，输出可视化的接口管理文档，其中json格式中包含接口标题、接口描述、接口地址、接口http请求方法(get、post、put、delete)、请求参数、请求参数数据结构、响应体字段、响应体参数数据结构、http header信息、http header样例、接口返回数据、接口返回数据结构等，并且支持接口信息的再次编辑，方便更好的管理接口文档；
14.步骤二，读取格式化完成的接口文档json，遍历整个json信息，根据请求参数、请求参数数据结构、响应体字段、响应体字段数据结构、http header信息等智能化输出接口测试样例；然后根据输出的接口测试样例结合接口http请求方法逐个运行接口，记录每个接口的返回数据，并与接口文档返回数据结构进行对比，完成对所有接口的快速校验。
15.步骤三，将所有接口的运行信息、运行结果输出成可视化文档报告，支持接口文档的导出与检索，方便快速查看每个接口的运行情况，快速排查有问题的接口信息。
16.进一步，所述步骤二中的运行信息包括接口的真实响应、接口真实的响应时长。
17.本发明的另一目的在于提供一种快速验证应用程序接口的装置包括：
18.api接口读取模块，支持导入或者手动录入遵循openapi3.0(原swagger)、json schema规范的文件，将文件输出成可视化的接口管理文档，文档包含接口接口标题、接口描述、接口地址、接口http请求方法(get、post、put、delete)、请求参数、请求参数数据结构、响应体字段、响应体参数数据结构、http header信息、http header样例、接口返回数据、接口返回数据结构等，并支持对这些信息进行再编辑、修改、导出；
19.api接口验证模块，读取格式化完成的接口文档json，根据请求参数、请求参数数据结构、响应体字段、响应体字段数据结构、http header信息等智能匹配响应字段输出接口测试样例；然后根据输出的接口测试样例结合接口http请求方法逐个运行接口，记录每个接口的返回数据，并与接口文档返回数据结构进行对比，完成对所有接口的快速校验；
20.api接口文档输出模块，用于将所有接口基本信息(标题、描述等)以及接口的请求结果组合保存为新的json信息，并读取json并输出相应的接口文档以及接口运行情况报表。
21.进一步，所述api接口读取模块在导入的api json文件中根据api接口对应的标题、描述、请求方法和请求参数信息对接口进行读取。
22.进一步，所述json格式中包含接口的标题、描述、接口地址、请求方法、请求参数、响应体信息。
23.进一步，所述api接口输出模块记录每个接口的接口标题、接口地址、请求方法、请求参数、响应信息、响应时长、错误信息，输出成文档。
24.进一步，所述api接口验证模块若接口调用成功，将接口的请求参数、响应信息与原始接口文档信息进行比较验证，查看接口是否按照文档要求的请求参数并按照要求输出响应，运行完成后对接口响应时间记录保存；若接口调用失败，将错误信息进行标记筛选，记录接口详细的错误信息。
25.结合上述的技术方案和解决的技术问题，请从以下几方面分析本发明所要保护的技术方案所具备的优点及积极效果为：
26.第一、针对上述现有技术存在的技术问题以及解决该问题的难度，紧密结合本发明的所要保护的技术方案以及研发过程中结果和数据等，详细、深刻地分析本发明技术方
案如何解决的技术问题，解决问题之后带来的一些具备创造性的技术效果。具体描述如下：
27.在当前的技术开发过程中，接口的管理和接口的测试等其他接口工具之间，往往因为数据不一致而难以调整，往往需要花费不必要的人力成本和时间成本。并且这里不仅仅是工作量的问题，更大的问题是多个系统之间数据不一致，导致协作低效，频繁出现问题，造成不必要的损失。
28.本发明技术方案是，支持导入openapi3.0规范的技术文档，读取接口文档包含接口标题、接口描述、接口地址、接口http请求方法(get、post、put、delete)、请求参数、请求参数数据结构、响应体字段、响应体参数数据结构、http header信息、http header样例、接口返回数据、接口返回数据结构等，然后输出可视化、可编辑、可导出的技术文档，并且根据参数数据结构、响应体的数据结构结合接口其他信息生成接口测试样例，完成对所有接口批量运行，并且记录每个接口的运行结果，定制化输出接口运行报表。
29.第二，把技术方案看做一个整体或者从产品的角度，本发明所要保护的技术方案具备的技术效果和优点，具体描述如下：
30.技术效果：通过本发明，可以自动化整理接口文档，持久化保存接口文档的记录和修改，方便以后对接口文档进行整理；本发明根据请求参数数据结构、请求体数据结构等，智能匹配接口信息，自动化生成测试样例，批量快速运行所有接口，并记录接口的运行时间、运行返回信息，并和原始文档作比对，最终生成定制化的测试报表；
31.优点：使用本发明后，开发人员不需要再进行接口文档整理，减少接口编写时间，并且支持可视化再编辑，能够更好管理接口文档信息；也不需要逐个编写测试样例和单独对接口进行测试，本发明可以自动匹配文档信息，生成测试样例，自动化完成对接口的测试工作，极大的提升开发效率，减少开发成本；测试完成后，还会生成每个接口的测试报表，对接口情况一目了然，能够帮助开发人员快速排查需要修复的接口。
32.第三，作为本发明的权利要求的创造性辅助证据，还体现在以下几个重要方面：
33.本发明的技术方案转化后的预期收益和商业价值为：使用本发明可以更好的进行项目接口的管理和测试。并且未来可以支持私有化的部署以及客户端软件，对普通用户和企业用户都能进行会员制收费和软件使用费。
34.本发明的技术方案是否解决了人们一直渴望解决、但始终未能获得成功的技术难题：解决开发人员接口文档的整理复杂的问题，支持项目接口持续化、可视化的编辑和预览；并且解决测试测试复杂繁琐的工作，加快项目项目的开发效率，减少开发成本。
附图说明
35.图1是本发明实施例提供的快速验证应用程序接口的装置的结构框图。
36.图2是本发明实施例提供的快速验证应用程序接口的装置的控制方法流程图。
37.图3是本发明实施例提供的快速验证应用程序接口的装置的控制方法原理图。
具体实施方式
38.为了使本发明的目的、技术方案及优点更加清楚明白，以下结合实施例，对本发明进行进一步详细说明。应当理解，此处所描述的具体实施例仅仅用以解释本发明，并不用于限定本发明。
39.一、解释说明实施例。为了使本领域技术人员充分了解本发明如何具体实现，该部分是对权利要求技术方案进行展开说明的解释说明实施例。
40.如图1所示，本发明实施例提供的快速验证应用程序接口的装置包括api接口读取模块、api接口验证模块和api接口输出模块。
41.api接口读取模块：读取openapi3.0规范的json文本，读取接口文档包含接口接口标题、接口描述、接口地址、接口http请求方法(get、post、put、delete)、请求参数、请求参数数据结构、响应体字段、响应体参数数据结构、http header信息、http header样例、接口返回数据、接口返回数据结构等，然后输出可视化、可编辑、可导出的技术文档。
42.api接口验证模块：读取格式化完成的接口文档json，根据请求参数、请求参数数据结构、响应体字段、响应体字段数据结构、http header信息等智能匹配响应字段输出接口测试样例；然后根据输出的接口测试样例结合接口http请求方法逐个运行接口，记录每个接口的返回数据，并与接口文档返回数据结构进行对比，完成对所有接口的快速校验。
43.api接口输出模块：将所有接口的请求信息保存为json信息，并输出相应的文档。记录每个接口的接口标题、接口地址、请求方法、请求参数、响应信息、响应时长、错误信息，输出成文档。
44.如图2所示，本发明实施例提供一种快速验证应用程序接口的装置的控制方法包括：
45.s101，通过api接口读取模块读取整个接口文档信息，将接口信息保存成方便读取的json格式，json格式中包含接口的标题、描述、接口地址、请求方法、请求参数、响应体信息；
46.s102，遍历格式化的json信息，将每个接口对应接口地址按照对应请求方法进行http请求，保存每个接口的运行信息，并对文档信息进行比较，筛选出有错误的接口；
47.s103，将所有接口的运行信息输出成报告，可视化展示每个接口的运行情况。
48.所述s102中的运行信息包括接口的真实响应、接口真实的响应时长。
49.图3是本发明实施例提供的快速验证应用程序接口的装置的控制方法原理。
50.二、应用实施例。为了证明本发明的技术方案的创造性和技术价值，该部分是对权利要求技术方案进行具体产品上或相关技术上的应用实施例。
51.本发明在互联网开发项目中，使用该技术完成对整个项目接口的管理和存档工作，并且快速完成对接口基础功能测试、并发测试等，使用该技术极大的方便了我们对接口的管理，再也不用像传统开发中，技术人员手工书写接口文档，并且难以持久化的保存。使用该技术，我们可以很方便的查询某个功能模块相关接口以及正确输入输出格式，并且能够可视化的编辑和预览。并且能够快速完成对接口的测试，快速找到接口存在的问题，方便我们快速去排查项目问题，加快开发效率。
52.三、实施例相关效果的证据。本发明实施例在研发或者使用过程中取得了一些积极效果，和现有技术相比的确具备很大的优势，下面内容结合试验过程的数据、图表等进行描述。
53.对比传统的软件开发中，对接口文档的管理更加智能化，不用手工书写每个接口的参数信息，自动化生成接口文档，智能输出测试样例，更为快捷的进行接口的测试，并且能够更好的保存文档信息。书写整个项目接口以及接口文档测试，可能要花3-4天时间，使
用我们的工具后只需前期开发过程中对文档进行标注，然后只需几分钟时间就能输出好完整的接口文档以及测试报告。
54.在本发明的描述中，除非另有说明，“多个”的含义是两个或两个以上；术语“上”、“下”、“左”、“右”、“内”、“外”、“前端”、“后端”、“头部”、“尾部”等指示的方位或位置关系为基于附图所示的方位或位置关系，仅是为了便于描述本发明和简化描述，而不是指示或暗示所指的装置或元件必须具有特定的方位、以特定的方位构造和操作，因此不能理解为对本发明的限制。此外，术语“第一”、“第二”、“第三”等仅用于描述目的，而不能理解为指示或暗示相对重要性。
55.应当注意，本发明的实施方式可以通过硬件、软件或者软件和硬件的结合来实现。硬件部分可以利用专用逻辑来实现；软件部分可以存储在存储器中，由适当的指令执行系统，例如微处理器或者专用设计硬件来执行。本领域的普通技术人员可以理解上述的设备和方法可以使用计算机可执行指令和/或包含在处理器控制代码中来实现，例如在诸如磁盘、cd或dvd-rom的载体介质、诸如只读存储器(固件)的可编程的存储器或者诸如光学或电子信号载体的数据载体上提供了这样的代码。本发明的设备及其模块可以由诸如超大规模集成电路或门阵列、诸如逻辑芯片、晶体管等的半导体、或者诸如现场可编程门阵列、可编程逻辑设备等的可编程硬件设备的硬件电路实现，也可以用由各种类型的处理器执行的软件实现，也可以由上述硬件电路和软件的结合例如固件来实现。
56.以上所述，仅为本发明的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，凡在本发明的精神和原则之内所作的任何修改、等同替换和改进等，都应涵盖在本发明的保护范围之内。