CN107423105A

CN107423105A - 一种接口文档的自动生成方法

Info

Publication number: CN107423105A
Application number: CN201710463853.2A
Authority: CN
Inventors: 雷晓鹏; 耿荣健
Original assignee: Shanghai Gunton Education Training Co Ltd
Current assignee: Shanghai Gunton Education Training Co Ltd
Priority date: 2017-06-19
Filing date: 2017-06-19
Publication date: 2017-12-01

Abstract

本发明涉及一种接口文档的自动生成方法，所述方法包括下列步骤：生成模拟请求信息；根据生成的模拟请求信息，向浏览器进行模拟请求，并收集浏览器的返回结果；根据浏览器的返回结果，自动生成接口文档。与现有技术相比，本发明具有降低开发人员编写接口文档的时间、自动化程度高以及实现方便等优点。

Description

一种接口文档的自动生成方法

技术领域

本发明涉及接口开发领域，尤其是涉及一种接口文档的自动生成方法。

背景技术

在接口开发中不仅要写好接口，同时还要提供完善的接口文档，在原有的接口管理中，需要有大量的接口文件编辑工作，开发人员每个接口都要按照规范编写接口文档，大大浪费了开发人员的开发时间。现有的一些接口文档的自动生成工具，要求开发人员在代码的注释中，加入大量注释文档，然后再提取出来，这样也增加了开发人员在接口开发过程中的工作量。

发明内容

本发明的目的是针对上述问题提供一种接口文档的自动生成方法。

本发明的目的可以通过以下技术方案来实现：

一种接口文档的自动生成方法，所述方法包括下列步骤：

1)生成模拟请求信息；

2)根据步骤1)生成的模拟请求信息，向浏览器进行模拟请求，并收集浏览器的返回结果；

3)根据浏览器的返回结果，自动生成接口文档。

所述生成模拟请求信息包括自动抓取模拟请求信息或手动编写模拟请求信息。

所述自动抓取模拟请求信息具体为：

11)在代理层级上对所有用户的请求进行抓取；

12)根据步骤11)抓取的结果进行分析，得到请求地址和请求参数，作为模拟请求信息。

所述步骤3)具体为：

31)对步骤2)中的返回结果进行分解，得到接口文档的相关数据；

32)根据步骤31)得到的相关数据进行分析，得到参数与参数含义的对应关系；

33)根据步骤22)得到的参数与参数含义的对应关系，按照接口文档的规范格式，生成接口文档。

所述步骤32)具体为：

321)对相关数据进行解包；

322)根据解包后的结果，判断参数是否有相匹配的参数解释，若是则进入323)，若否则进入324)；

323)将参数相匹配的参数解释作为参数含义，得到参数与参数含义的对应关系；

324)将空集作为参数的参数含义，得到参数与参数含义的对应关系。

所述解包后的结果包括参数名称、参数解释、参数类型和参数之间的关系。

所述步骤321)还包括：对解包后的结果，过滤其中相同的参数。

所述方法还包括：提示开发人员补充接口文档中的空缺项。

与现有技术相比，本发明具有以下有益效果：

(1)由于现有的接口基本都是采用json格式返回值，较为规范，因而开发人员在接口的编写过程中，会对绝大部分的参数，使用相同的参数名，因而返回值的名称也就对应了参数的解释，本发明利用了接口编写的这一特点，通过向浏览器发送模拟请求信息来获得返回结果，从返回结果中提取参数含义从而自动生成接口文档，这种生成方式自动化程度高，且无需开发人员在编写过程中的注释即可实现，实现方式简单且实用性能强。

(2)在生成模拟请求信息时，一方面可以在代理层上自动抓取模拟请求信息，另一方面也可以手动编写模拟请求信息，在实际应用过程中，可以二者之间相互配合，保证请求信息的全面，从而使得获得的模拟请求的返回结果较为全面，从而可以得到绝大部分参数的对应解释。

(3)在得到返回信息后，通过将其解包并提取参数名称以及对应的参数解释，从而得到参数和对应的参数含义，在找不到对应的参数解释时，则将空集作为参数的含义，在后续过程中提醒开发人员进行补充，这种方式简单且对计算能力的要求不高，因而可以大范围使用。

(4)对解包后的结果，首先会过滤其中相同的参数，减少了后续的工作量，提高了自动生成的速率。

(5)在自动生成接口文档后提示用户补充接口文档中的空缺项，保证了接口文档的完整，准确程度高。

(6)该自动生成接口文档的方法并非是以代码为依据，因而可以实现代码与接口文档的隔离，即无需根据代码的改变而返回对接口文档进行修改，只需在浏览器中进行模拟请求即可实现对接口文档的更新。

附图说明

图1为本发明的方法流程图。

具体实施方式

下面结合附图和具体实施例对本发明进行详细说明。本实施例以本发明技术方案为前提进行实施，给出了详细的实施方式和具体的操作过程，但本发明的保护范围不限于下述的实施例。

如图1所示，本实施例提出了一种接口文档的自动生成方法，包括下列步骤：

1)生成模拟请求信息(包括自动抓取模拟请求信息或手动编写模拟请求信息)，其中自动抓取模拟请求信息的过程为：

11)在代理层级上对所有用户的请求进行抓取；

12)根据步骤11)抓取的结果进行分析，得到请求地址和请求参数，作为模拟请求信息；

3)根据浏览器的返回结果，自动生成接口文档，具体为：

32)根据步骤31)得到的相关数据进行分析，得到参数与参数含义的对应关系：

321)对相关数据进行解包，对解包后的结果，过滤其中相同的参数；

322)根据解包后的结果(包括参数名称、参数解释、参数类型和参数之间的关系)，判断参数是否有相匹配的参数解释，若是则进入323)，若否则进入324)；

324)将空集作为参数的参数含义，得到参数与参数含义的对应关系；

在上述步骤结束后，可以提示开发人员补充接口文档中的空缺项。

根据上述步骤进行的接口文档自动生成过程如下：首先进行请求数据收集，可以自动抓包，获取到请求的具体信息，分析请求数据，对请求的具体信息分析，得到请求的地址，请求参数，以及其他的请求必要信息；也可以自己手动写入请求信息，代码中自动在请求时对信息进行分析处理。得到请求地址，参数。继而进行返回数据收集：通过收集的请求参数，进行模拟浏览器请求，然后获取到返回的数据。针对返回的数据进行解包分析，得到不同数据的关系，值类型，参数名，过滤相同的数据信息。最终执行入库操作，针对整理好的数据信息，按照要求存储在数据库中。同时对已经认识的参数名自动写入注释解释，方便接口接入人员的查阅。上述方法只需简单提供url和参数就能完整的生成文档，在具体操作时下载脚本文件，将需要生成文档的url，拼接好，可以在浏览器中先测试下能否返回正常的数据，没有问题则写在手动读取信息的文件中，接着检查配置文件的数据库配置信息是否正常，没问题则运行入口文件，将会自动生成文档，同时提供文档修改地址，可以自行优化。这样一个文档就算编辑完毕再进行简单的修改就能使用，相对于之前文档一个一个手动录入，时间由原本的30分钟一个接口文档，压缩为5分钟之内就能完成，节约时间将近5倍。

Claims

1.一种接口文档的自动生成方法，其特征在于，所述方法包括下列步骤：

1)生成模拟请求信息；

3)根据浏览器的返回结果，自动生成接口文档。

2.根据权利要求1所述的接口文档的自动生成方法，其特征在于，所述生成模拟请求信息包括自动抓取模拟请求信息或手动编写模拟请求信息。

3.根据权利要求2所述的接口文档的自动生成方法，其特征在于，所述自动抓取模拟请求信息具体为：

11)在代理层级上对所有用户的请求进行抓取；

4.根据权利要求1所述的接口文档的自动生成方法，其特征在于，所述步骤3)具体为：

5.根据权利要求4所述的接口文档的自动生成方法，其特征在于，所述步骤32)具体为：

321)对相关数据进行解包；

6.根据权利要求5所述的接口文档的自动生成方法，其特征在于，所述解包后的结果包括参数名称、参数解释、参数类型和参数之间的关系。

7.根据权利要求5所述的接口文档的自动生成方法，其特征在于，所述步骤321)还包括：对解包后的结果，过滤其中相同的参数。

8.根据权利要求1所述的接口文档的自动生成方法，其特征在于，所述方法还包括：提示开发人员补充接口文档中的空缺项。