CN110196733A - 一种预设api文档生成方法、装置、设备和存储介质 - Google Patents
一种预设api文档生成方法、装置、设备和存储介质 Download PDFInfo
- Publication number
- CN110196733A CN110196733A CN201910492544.7A CN201910492544A CN110196733A CN 110196733 A CN110196733 A CN 110196733A CN 201910492544 A CN201910492544 A CN 201910492544A CN 110196733 A CN110196733 A CN 110196733A
- Authority
- CN
- China
- Prior art keywords
- interface
- document
- api
- default
- api document
- Prior art date
- Legal status (The legal status is an assumption and is not a legal conclusion. Google has not performed a legal analysis and makes no representation as to the accuracy of the status listed.)
- Pending
Links
- 238000000034 method Methods 0.000 title claims abstract description 58
- 238000012360 testing method Methods 0.000 claims abstract description 75
- 239000004753 textile Substances 0.000 claims description 8
- 238000004590 computer program Methods 0.000 claims description 2
- 230000015654 memory Effects 0.000 description 16
- 238000010586 diagram Methods 0.000 description 10
- 230000006870 function Effects 0.000 description 7
- 230000000694 effects Effects 0.000 description 4
- 239000010979 ruby Substances 0.000 description 4
- 229910001750 ruby Inorganic materials 0.000 description 4
- 230000018109 developmental process Effects 0.000 description 3
- 230000004044 response Effects 0.000 description 3
- 230000015556 catabolic process Effects 0.000 description 2
- 230000007613 environmental effect Effects 0.000 description 2
- 230000008676 import Effects 0.000 description 2
- 238000004088 simulation Methods 0.000 description 2
- 241000208340 Araliaceae Species 0.000 description 1
- 241001269238 Data Species 0.000 description 1
- 235000005035 Panax pseudoginseng ssp. pseudoginseng Nutrition 0.000 description 1
- 235000003140 Panax quinquefolius Nutrition 0.000 description 1
- 208000013738 Sleep Initiation and Maintenance disease Diseases 0.000 description 1
- 230000006399 behavior Effects 0.000 description 1
- 230000009286 beneficial effect Effects 0.000 description 1
- 238000006243 chemical reaction Methods 0.000 description 1
- 238000004891 communication Methods 0.000 description 1
- 238000011161 development Methods 0.000 description 1
- 235000013399 edible fruits Nutrition 0.000 description 1
- 239000000284 extract Substances 0.000 description 1
- 235000008434 ginseng Nutrition 0.000 description 1
- 206010022437 insomnia Diseases 0.000 description 1
- 238000012545 processing Methods 0.000 description 1
- 239000007787 solid Substances 0.000 description 1
- 238000010998 test method Methods 0.000 description 1
- 238000012795 verification Methods 0.000 description 1
Classifications
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/12—Use of codes for handling textual entities
- G06F40/137—Hierarchical processing, e.g. outlines
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/166—Editing, e.g. inserting or deleting
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F40/00—Handling natural language data
- G06F40/10—Text processing
- G06F40/166—Editing, e.g. inserting or deleting
- G06F40/169—Annotation, e.g. comment data or footnotes
-
- G—PHYSICS
- G06—COMPUTING; CALCULATING OR COUNTING
- G06F—ELECTRIC DIGITAL DATA PROCESSING
- G06F8/00—Arrangements for software engineering
- G06F8/70—Software maintenance or management
- G06F8/73—Program documentation
Landscapes
- Engineering & Computer Science (AREA)
- Theoretical Computer Science (AREA)
- General Engineering & Computer Science (AREA)
- Physics & Mathematics (AREA)
- General Physics & Mathematics (AREA)
- Health & Medical Sciences (AREA)
- Artificial Intelligence (AREA)
- Audiology, Speech & Language Pathology (AREA)
- Computational Linguistics (AREA)
- General Health & Medical Sciences (AREA)
- Software Systems (AREA)
- Library & Information Science (AREA)
- Debugging And Monitoring (AREA)
Abstract
本发明实施例公开了一种预设API文档生成方法、装置、设备及存储介质。其方法包括：接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；获取待测试接口的接口测试文件；获取文档头部；其中，所述文档头部包括目录信息；运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。本发明实施例在进行自动化接口测试的同时，便可生成API文档和API调试文档，减少了大量的人工编码与注释，且不易出错。
Description
技术领域
本发明实施例涉及软件开发与软件测试领域，尤其涉及一种预设API文档生成方法、装置、设备和存储介质。
背景技术
随着移动应用的普及，后台开发人员承担了更多的接口开发任务，在做接口开发时免不了要编写API文档与录入数据进API调试工具。
目前流行两种自动化生成API文档的方案，方案一是利用注解生成API文档，典型案例为swagger，其缺点是需要编写冗长的API描述文档；方案二是利用注释生成API文档，典型案例为apidoc，其缺点是开发人员需维护大量的注释代码，这与手写文档无本质区别。上述两种方案的共同缺点是参数示例与返回值示例都需人工编码。目前流行两种录入数据进API调试工具的方案，方案一是人工录入，其缺点是需要大量的人工操作；方案二是导入swagger格式的API描述文档到API调试工具，但需要开发人员进行繁琐编码。
综上所述，通过现有技术自动生成API文档时，仍然需要大量的人工编码与注释，而且API文档无法自动生成，仍然要靠人工录入或编码，这将给开发人员带来大量工作量，进一步地，大量人员操作也将不可避免的出现错误，导致文档与代码脱节，使得文档与代码所述不符，影响开发工作的顺利进行。
发明内容
本发明实施例提供一种预设API文档生成方法、装置、设备及存储介质，以实现减少人工操作，减少出错的技术效果。
第一方面，本发明实施例提供了一种预设API文档生成方法，包括：
接收生成预设API文档的指令，获取预设API文档的文件格式；其中，预设API文档包括API文档和/或API调试文档；
获取待测试接口的接口测试文件；
获取文档头部；其中，文档头部包括目录信息；
运行接口测试文件，生成待测试接口对应的预设API文档片段；
根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
第二方面，本发明实施例提供了一种预设API文档生成装置，包括：
指令接收模块，用于接收生成预设API文档的指令，获取预设API文档的文件格式；其中，预设API文档包括API文档和/或API调试文档；
接口测试文件获取模块，用于获取待测试接口的接口测试文件；
文档头部获取模块，用于获取文档头部；其中，文档头部包括目录信息；
接口测试文件运行模块，用于运行接口测试文件，生成待测试接口对应的预设API文档片段；
预设API文档生成模块，用于根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
第三方面，本发明实施例提供了一种设备，包括：
一个或多个处理器；
存储装置，用于存储一个或多个程序，
当一个或多个程序被一个或多个处理器执行，使得一个或多个处理器实现如本发明任意实施例提供的预设API文档生成方法。
第四方面，本发明实施例还提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现如本发明任意实施例提供的预设API文档生成方法。
本发明实施例通过自动化接口测试，生成对应的文档片段，进而根据获取到的文档头部和文档片段生成对应的预设API文档，解决了现有技术仍然需要大量人工操作导致人工成本高，而且错误多的问题，实现减少人工操作，减少出错的技术效果。
附图说明
图1是本发明实施例一提供的一种预设API文档生成方法的流程图。
图2是本发明实施例一提供的一种预设API文档生成方法的工作原理示意图。
图3是本发明实施例二提供的一种预设API文档生成方法的流程图。
图4是本发明实施例二提供的单个预设API文档片段生成方法的流程图。
图5所示为本发明实施例二提供的API文档生成结果示意图。
图6所示为本发明实施例三提供的一种预设API文档生成装置的结构示意图。
图7所示为本发明实施例四提供的一种设备的结构示意图。
具体实施方式
下面结合附图和实施例对本发明作进一步的详细说明。可以理解的是，此处所描述的具体实施例仅仅用于解释本发明，而非对本发明的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与本发明相关的部分而非全部结构。
实施例一
图1为本发明实施例一提供的一种预设API文档生成方法的流程图，本实施例可适用于基于自动化接口测试生成API文档和/或API调试文档的情况，该方法可以由预设API文档生成装置来执行，该装置可以采用软件和/或硬件的方式实现，并配置在计算机设备中。该方法具体包括如下步骤：
步骤110、接收生成预设API文档的指令，获取预设API文档的文件格式。
其中，预设API文档是一个自定义的统称，可以包括API文档和/或API调试文档。API文档的文件格式并无要求，例如，可以使用超文本标记语言(Hyper Text Mark-upLanguage，HTML)、Markdown和Textile等格式。API调试文档的文件格式为API调试工具支持的文件格式，例如，API调试工具可以是Postman或Insomnia，API调试文档格式可以是Json。通常，可以利用计算机中用于编写网络应用程序的软件包来完成预设API文档的生成，此类软件包可以为程序开发人员开发数据库驱动的网络应用程序提供强大的框架支持，例如，软件包接收生成API和/或API调试文档的指令，并获取要生成的API和/或API调试文档的文件格式。
步骤120、获取待测试接口的接口测试文件。
其中，待测试接口是指在进行自动化接口测试时需要测试的接口。接口测试文件与待测试接口一一对应，接口测试文件中包括自动化接口测试的方法定义。
步骤130、获取文档头部。
其中，文档头部是指位于预设API文档的起始部位的信息，需由人工写入，包括目录信息，该目录信息对要生成的预设API文档具有指引作用。
步骤140、运行接口测试文件，生成待测试接口对应的预设API文档片段。
其中，预设API文档片段包括了对应待测试接口的API文档或API调试文档中应有的一般性信息，例如，接口信息、参数信息以及返回信息等。运行接口测试文件，即按照接口测试文件中的接口测试方法定义进行接口测试。通过遍历待测试接口对应的接口测试文件，可得到待测试接口对应的预设API文档片段，可以理解的是，每个接口测试完成后，即可在预设API文档中追加该接口的预设API文档片段。
步骤150、根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
其中，当待测试接口测试完成后，根据上述文档头部以及依次追加到预设API文档中的待测试接口对应的预设API文档片段，便可生成预先设定的预设API文档文件格式下的预设API文档。
可以理解的是，当各预设API文档片段生成完成后，该预设API文档的尾部还包括若干“}”等符号做结尾，该结尾需人工手动写入。
图2所示为本发明实施例技术方案的工作原理示意图。该预设API文档生成方法的工作原理是：自动化接口测试通过模拟客户端向服务器发送请求报文并接受服务器应答结果，因此，基于该原理，通过在软件包中运行待测试接口的接口测试文件，可以让程序开发人员在进行自动化接口测试的同时，即可获取API文档和API调试文档的接口信息、参数信息和返回信息等信息，进而生成API文档和API调试文档。而且，在整个过程中仅需要人工写入文档头部的目录信息、尾部信息以及运行接口测试文件的代码，很大程度上减少人工操作，另外，所生成的预设API文档中的数据均是通过自动化接口测试获得的，不需要人工编码，因此不易出错。
本发明实施例通过自动化接口测试，生成对应的文档片段，进而根据获取到的文档头部和文档片段生成对应的预设API文档，解决了现有技术仍然需要大量人工操作导致人工成本高，而且错误多的问题，实现减少人工操作，减少出错的技术效果。
实施例二
图3是本发明实施例二提供的一种预设API文档生成方法的流程图。本实施例以上述实施例为基础，如图3所示，具体可以包括如下步骤：
步骤210、接收生成预设API文档的指令，获取预设API文档的文件格式。
需要说明的是，本实施例可以在Ruby on Rails软件包上得到实施，它是一种基于计算机软件语言Ruby的框架，但本发明的实施方式不局限于此框架和此计算机软件语言。
可选的，API文档文件格式采用Textile，本发明实施例API调试文档文件格式采用Json。需要说明的是，本发明的API文档文件格式不局限于Textile，API文档文件格式不局限于Json。
步骤220、获取待测试接口的接口测试文件。
其中，接口测试文件具有对应的模块名。可选的，规定待测试接口的接口测试文件的执行顺序。
步骤230、获取文档头部。
可选的，文档头部的目录信息包括：文档的全局说明、生成时间、作者和目录表达式。
具体的，对于API文档，获取文档头部即往文档逐行写入文档的全局说明、生成时间、作者、Textile目录表达式(用以告知Textile解析器根据整个文档生成目录)；对于API调试文档，需要按照Postman等调试工具支持的解析格式写入上述文档头部信息。
步骤240、获取接口测试文件对应的模块名。
其中，模块名是指接口测试文件的文件名称，文件名称的命名方式并无限定，例如可以是阿拉伯数字、英文字母或者具有实际含义的中文词语等。
步骤250、将模块名设置于文档头部之后，作为待测试接口对应的预设API文档片段的模块标题和一级目录。
在写入文档头部之后，先往API文档中追加该测试文件对应的模块名，作为待测试接口对应的预设API文档片段的模块标题和一级目录。
步骤260、运行接口测试文件，生成待测试接口对应的预设API文档片段。
可选的，运行接口测试文件包括：通过源代码扫描，从接口测试文件中获取接口名、接口参数说明和接口返回值说明；通过模拟接口请求，从接口测试文件中获取接口请求地址、接口请求头示例、接口参数示例和接口返回值示例。
其中，源代码即接口的定义。通常，接口开发人员定义普通接口的步骤如下：
1)在接口定义上方书写普通方法注释，描述接口的功能；
2)在接口方法执行体的前几行进行参数校验，详细描述参数字段名，参数类型，参数是否必填，参数说明；此处调用了常规的接口参数校验方法，但也可使用注释进行以上内容的说明；
3)空行；
4)接口业务逻辑处理代码；
5)方法返回，对返回属性做类型转化和行注释。
如图4所示的单个预设API文档片段的生成方法示意图。具体的，在进行源代码扫描时，将扫描到的方法注释映射为接口名，或者说直接将方法注释作为接口名；接口的方法执行体的第一行至空行处的代码块经解析作为接口参数说明，解析原则为逐行分离出参数名，参数是否必填，参数类型，参数说明，或者说从此部分代码块中提取出参数名，参数是否必填，参数类型，参数说明；接口的方法返回代码块经解析作为接口返回值说明，解析原则为逐行分离出返回参数名，返回参数类型，返回参数说明，或者说从此部分代码块中提取出返回参数名，返回参数类型，返回参数说明。
可选的，若编程语言及框架支持读取接口源代码，则直接读取所述待测试接口的源代码，例如本实施例所采用的Ruby on Rails框架及Ruby语言；若编程语言及框架不支持读取接口源代码，则通过测试代码配置接口的所在文件名及方法名，在接口测试时根据所述文件名和所述方法名读取所述待测试接口的源代码。
其中，模拟接口请求是指模拟参数输入，并生成结果输出，包括如下步骤：
1)定义模拟数据；
2)设置接口参数；
3)设置请求头；
4)设置接口请求地址；
5)发送请求；
6)对响应结果进行断言。
具体的，上述步骤中的“设置”即模拟参数输入的过程。如图4所示的单个预设API文档片段的生成方法示意图，将模拟请求地址映射为请求地址，模拟请求参数经格式化后作为参数示例，格式化即利用软件工具对上述请求参数进行格式上的美化；请求后得到的响应结果经格式化后作为返回值示例；模拟请求头经格式化后作为请求头示例。
可选的，生成待测试接口对应的预设API文档片段包括：根据接口名、接口参数说明、接口返回值说明、接口请求地址、接口参数示例和接口返回值示例生成API文档片段；和/或
根据接口名、接口请求地址、接口参数示例和接口请求头示例生成API调试文档片段。
可选的，对于API调试文档，接口请求地址、接口参数示例和接口请求头示例均还支持直接写成环境变量，交由API调试工具根据使用环境进行赋值，需按照调试工具支持的解析格式构建API调试文档片段的相应部分。
步骤270、根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
其中，图5为本发明实施例提供的API文档生成结果示意图。该API文档中包含了文档头部以及各待测试接口的API文档片段，通过上述内容生成Textile格式下的API文档。API预设文档的生成同理。
本实施例提供的技术方案，通过对接口测试文件设置对应的模块名；并在运行接口测试文件之前，获取接口测试文件对应的模块名；将模块名设置于文档头部之后，作为待测试接口对应的预设API文档片段的模块标题和一级目录的技术方案，由于在每一个生成的预设API文档片段之前显示该片段的模块名，可以使生成的预设API文档更加清晰、有条理。
另外，由于可根据需要定义不同的文档文件格式，因此该文档可以具有不同的显示形式，以满足个人喜好及兼容原有API文档的需要，使得个性化需求定制更简单。除此之外，由于无需手动录入或编写机器可读的swagger描述文档，因此通过本实施例的技术方案生成的API调试文档更方便录入数据进调试工具，只需导入生成好的API调试文档即可。而且该API调试文档支持调试工具定义环境变量，使其实用性更强。
实施例三
图6为本发明实施例三提供的一种预设API文档生成装置的结构示意图，可通过执行预设API文档生成方法来进行API文档和/或API调试文档的生成。如图6所示，该装置包括：
指令接收模块310，用于接收生成预设API文档的指令，获取预设API文档的文件格式；其中，预设API文档包括API文档和/或API调试文档；
接口测试文件获取模块320，用于获取待测试接口的接口测试文件；
文档头部获取模块330，用于获取文档头部；其中，文档头部包括目录信息；
接口测试文件运行模块340，用于运行接口测试文件，生成待测试接口对应的预设API文档片段；
预设API文档生成模块350，用于根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
本发明实施例通过自动化接口测试，生成对应的文档片段，进而根据获取到的文档头部和文档片段生成对应的预设API文档，解决了现有技术仍然需要大量人工操作导致人工成本高，而且错误多的问题，实现减少人工操作，减少出错的技术效果。
在上述实施例的基础上，可选的，接口测试文件具有对应的模块名；该装置还包括：
模块名获取模块，用于在运行接口测试文件之前，获取接口测试文件对应的模块名；
模块名设置模块，用于将模块名设置于文档头部之后，作为待测试接口对应的预设API文档片段的模块标题和一级目录。
可选的，接口测试文件运行模块340包括：
源代码扫描单元，用于通过源代码扫描，从接口测试文件中获取接口名、接口参数说明和接口返回值说明；
接口请求模拟单元，用于通过模拟接口请求，从接口测试文件中获取接口请求地址、接口请求头示例、接口参数示例和接口返回值示例；
API文档片段生成单元，用于根据接口名、接口参数说明、接口返回值说明、接口请求地址、接口参数示例和接口返回值示例生成API文档片段；和/或
API调试文档片段生成单元，用于根据接口名、接口请求地址、接口参数示例和接口请求头示例生成API调试文档片段。
可选的，源代码扫描单元具体用于：
若编程语言及框架支持读取接口源代码，则直接读取待测试接口的源代码；若编程语言及框架不支持读取接口源代码，则通过测试代码配置接口的所在文件名及方法名，在接口测试时根据文件名和方法名读取待测试接口的源代码。
可选的，预设API文档的文件格式包括：API文档的文件格式为Textile；API调试文档的文件格式为Json。
可选的，目录信息包括：文档的全局说明、生成时间、作者和目录表达式。
本发明实施例所提供的预设API文档生成装置可执行本发明任意实施例所提供的预设API文档生成方法，具备执行方法相应的功能模块和有益效果。
实施例四
图7为本发明实施例四提供的一种设备的结构示意图，如图7所示，该设备包括处理器410、存储器420、输入装置430和输出装置440；设备中处理器410的数量可以是一个或多个，图7中以一个处理器410为例；设备中的处理器410、存储器420、输入装置430和输出装置440可以通过总线或其他方式连接，图7中以通过总线连接为例。
存储器420作为一种计算机可读存储介质，可用于存储软件程序、计算机可执行程序以及模块，如本发明实施例中的预设API文档生成方法对应的程序模块(例如，预设API文档生成装置中的指令接收模块310，接口测试文件获取模块320，文档头部获取模块330，接口测试文件运行模块340和预设API文档生成模块350)。处理器410通过运行存储在存储器420中的软件程序、指令以及模块，从而执行设备的各种功能应用以及数据处理，即实现上述的预设API文档生成方法。
存储器420可主要包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需的应用程序；存储数据区可存储根据终端的使用所创建的数据等。此外，存储器420可以包括高速随机存取存储器，还可以包括非易失性存储器，例如至少一个磁盘存储器件、闪存器件、或其他非易失性固态存储器件。在一些实例中，存储器420可进一步包括相对于处理器410远程设置的存储器，这些远程存储器可以通过网络连接至设备。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。
输入装置430可用于接收输入的数字或字符信息，以及产生与设备的用户设置以及功能控制有关的键信号输入。输出装置440可包括显示屏等显示设备。
实施例五
本发明实施例五还提供一种包含计算机可执行指令的存储介质，所述计算机可执行指令在由计算机处理器执行时用于执行一种预设API文档生成方法，该方法包括：
接收生成预设API文档的指令，获取预设API文档的文件格式；
获取待测试接口的接口测试文件；
获取文档头部；
运行接口测试文件，生成待测试接口对应的预设API文档片段；
根据文档头部和待测试接口对应的预设API文档片段，基于文件格式，生成预设API文档。
当然，本发明实施例所提供的一种包含计算机可执行指令的存储介质，其计算机可执行指令不限于如上所述的方法操作，还可以执行本发明任意实施例所提供的预设API文档生成方法中的相关操作。
通过以上关于实施方式的描述，所属领域的技术人员可以清楚地了解到，本发明可借助软件及必需的通用硬件来实现，当然也可以通过硬件实现，但很多情况下前者是更佳的实施方式。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分可以以软件产品的形式体现出来，该计算机软件产品可以存储在计算机可读存储介质中，如计算机的软盘、只读存储器(Read-Only Memory,ROM)、随机存取存储器(RandomAccess Memory,RAM)、闪存(FLASH)、硬盘或光盘等，包括若干指令用以使得一台计算机设备(可以是个人计算机，服务器，或者网络设备等)执行本发明各个实施例所述的方法。
值得注意的是，上述预设API文档生成装置的实施例中，所包括的模块只是按照功能逻辑进行划分的，但并不局限于上述的划分，只要能够实现相应的功能即可；另外，各功能模块的具体名称也只是为了便于相互区分，并不用于限制本发明的保护范围。
注意，上述仅为本发明的较佳实施例及所运用技术原理。本领域技术人员会理解，本发明不限于这里所述的特定实施例，对本领域技术人员来说能够进行各种明显的变化、重新调整和替代而不会脱离本发明的保护范围。因此，虽然通过以上实施例对本发明进行了较为详细的说明，但是本发明不仅仅限于以上实施例，在不脱离本发明构思的情况下，还可以包括更多其他等效实施例，而本发明的范围由所附的权利要求范围决定。
Claims (10)
1.一种预设API文档生成方法，其特征在于，包括：
接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；
获取待测试接口的接口测试文件；
获取文档头部；其中，所述文档头部包括目录信息；
运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；
根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。
2.根据权利要求1所述的预设API文档生成方法，其特征在于，所述接口测试文件具有对应的模块名；以及
在所述运行所述接口测试文件之前，还包括：
获取所述接口测试文件对应的所述模块名；
将所述模块名设置于所述文档头部之后，作为所述待测试接口对应的所述预设API文档片段的模块标题和一级目录。
3.根据权利要求1所述的预设API文档生成方法，其特征在于，所述运行所述接口测试文件，包括：
通过源代码扫描，从所述接口测试文件中获取接口名、接口参数说明和接口返回值说明；
通过模拟接口请求，从所述接口测试文件中获取接口请求地址、接口请求头示例、接口参数示例和接口返回值示例；
所述生成所述待测试接口对应的所述预设API文档片段，包括：
根据所述接口名、所述接口参数说明、所述接口返回值说明、所述接口请求地址、所述接口参数示例和所述接口返回值示例生成API文档片段；和/或
根据所述接口名、所述接口请求地址、所述接口参数示例和所述接口请求头示例生成API调试文档片段。
4.根据权利要求3所述的预设API文档生成方法，其特征在于，所述源代码扫描，包括：
若编程语言及框架支持读取接口源代码，则直接读取所述待测试接口的源代码；
若编程语言及框架不支持读取接口源代码，则通过测试代码配置接口的所在文件名及方法名，在接口测试时根据所述文件名和所述方法名读取所述待测试接口的源代码。
5.根据权利要求1所述的预设API文档生成方法，其特征在于，所述预设API文档的文件格式，包括：
所述API文档的文件格式为Textile；
所述API调试文档的文件格式为Json。
6.根据权利要求1所述的预设API文档生成方法，其特征在于，所述目录信息，包括：
文档的全局说明、生成时间、作者和目录表达式。
7.一种预设API文档生成装置，其特征在于，包括：
指令接收模块，用于接收生成预设API文档的指令，获取所述预设API文档的文件格式；其中，所述预设API文档包括API文档和/或API调试文档；
接口测试文件获取模块，用于获取待测试接口的接口测试文件；
文档头部获取模块，用于获取文档头部；其中，所述文档头部包括目录信息；
接口测试文件运行模块，用于运行所述接口测试文件，生成所述待测试接口对应的所述预设API文档片段；
预设API文档生成模块，用于根据所述文档头部和所述待测试接口对应的所述预设API文档片段，基于所述文件格式，生成所述预设API文档。
8.根据权利要求7所述的预设API文档生成装置，其特征在于，所述接口测试文件具有对应的模块名；
所述预设API文档生成装置还包括：
模块名获取模块，用于在所述运行所述接口测试文件之前，获取所述接口测试文件对应的所述模块名；
模块名设置模块，用于将所述模块名设置于所述文档头部之后，作为所述待测试接口对应的所述预设API文档片段的模块标题和一级目录。
9.一种设备，其特征在于，所述设备包括：
一个或多个处理器；
存储装置，用于存储一个或多个程序，
当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现如权利要求1-6中任一所述的预设API文档生成方法。
10.一种计算机可读存储介质，其上存储有计算机程序，其特征在于，该程序被处理器执行时实现如权利要求1-6中任一所述的预设API文档生成方法。
Priority Applications (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910492544.7A CN110196733A (zh) | 2019-06-06 | 2019-06-06 | 一种预设api文档生成方法、装置、设备和存储介质 |
Applications Claiming Priority (1)
| Application Number | Priority Date | Filing Date | Title |
|---|---|---|---|
| CN201910492544.7A CN110196733A (zh) | 2019-06-06 | 2019-06-06 | 一种预设api文档生成方法、装置、设备和存储介质 |
Publications (1)
| Publication Number | Publication Date |
|---|---|
| CN110196733A true CN110196733A (zh) | 2019-09-03 |
Family
ID=67754115
Family Applications (1)
| Application Number | Title | Priority Date | Filing Date |
|---|---|---|---|
| CN201910492544.7A Pending CN110196733A (zh) | 2019-06-06 | 2019-06-06 | 一种预设api文档生成方法、装置、设备和存储介质 |
Country Status (1)
| Country | Link |
|---|---|
| CN (1) | CN110196733A (zh) |
Cited By (8)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN111010438A (zh) * | 2019-12-13 | 2020-04-14 | 北京达佳互联信息技术有限公司 | 远程过程调用方法、装置、服务器及存储介质 |
| CN111124924A (zh) * | 2019-12-25 | 2020-05-08 | 五八同城信息技术有限公司 | Api部署方法、装置、电子设备及存储介质 |
| CN111290996A (zh) * | 2020-01-16 | 2020-06-16 | 平安医疗健康管理股份有限公司 | 文档格式转换方法、装置、设备及可读存储介质 |
| CN111399900A (zh) * | 2020-03-10 | 2020-07-10 | 山东汇贸电子口岸有限公司 | 一种基于python与正则表达式的API文档自动生成方法及系统 |
| CN111930635A (zh) * | 2020-09-17 | 2020-11-13 | 深圳微品致远信息科技有限公司 | 基于swagger快速自动化测试的方法及系统 |
| CN112130830A (zh) * | 2020-08-25 | 2020-12-25 | 汉海信息技术(上海)有限公司 | 接口生成方法、装置及电子设备 |
| CN112631694A (zh) * | 2020-12-11 | 2021-04-09 | 远光软件股份有限公司 | 一种api接口封装调用方法及系统 |
| CN112860551A (zh) * | 2021-02-02 | 2021-05-28 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20160232136A1 (en) * | 2015-02-10 | 2016-08-11 | International Business Machines Corporation | Debugging document formatting system |
| US20160371297A1 (en) * | 2015-01-12 | 2016-12-22 | Qumulo, Inc. | Filesystem capacity and performance metrics and visualizations |
| CN107885499A (zh) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | 一种接口文档生成方法及终端设备 |
| CN109032663A (zh) * | 2018-07-09 | 2018-12-18 | 深圳市小牛在线互联网信息咨询有限公司 | 接口文档的生成方法、装置、计算机设备及存储介质 |
| CN109725933A (zh) * | 2018-05-24 | 2019-05-07 | 中国平安人寿保险股份有限公司 | 大数据文档生成方法、装置、设备及计算机可读存储介质 |
-
2019
- 2019-06-06 CN CN201910492544.7A patent/CN110196733A/zh active Pending
Patent Citations (5)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| US20160371297A1 (en) * | 2015-01-12 | 2016-12-22 | Qumulo, Inc. | Filesystem capacity and performance metrics and visualizations |
| US20160232136A1 (en) * | 2015-02-10 | 2016-08-11 | International Business Machines Corporation | Debugging document formatting system |
| CN107885499A (zh) * | 2017-10-19 | 2018-04-06 | 平安壹钱包电子商务有限公司 | 一种接口文档生成方法及终端设备 |
| CN109725933A (zh) * | 2018-05-24 | 2019-05-07 | 中国平安人寿保险股份有限公司 | 大数据文档生成方法、装置、设备及计算机可读存储介质 |
| CN109032663A (zh) * | 2018-07-09 | 2018-12-18 | 深圳市小牛在线互联网信息咨询有限公司 | 接口文档的生成方法、装置、计算机设备及存储介质 |
Cited By (14)
| Publication number | Priority date | Publication date | Assignee | Title |
|---|---|---|---|---|
| CN111010438B (zh) * | 2019-12-13 | 2022-11-11 | 北京达佳互联信息技术有限公司 | 远程过程调用方法、装置、服务器及存储介质 |
| CN111010438A (zh) * | 2019-12-13 | 2020-04-14 | 北京达佳互联信息技术有限公司 | 远程过程调用方法、装置、服务器及存储介质 |
| CN111124924A (zh) * | 2019-12-25 | 2020-05-08 | 五八同城信息技术有限公司 | Api部署方法、装置、电子设备及存储介质 |
| CN111124924B (zh) * | 2019-12-25 | 2023-05-12 | 五八同城信息技术有限公司 | Api部署方法、装置、电子设备及存储介质 |
| CN111290996A (zh) * | 2020-01-16 | 2020-06-16 | 平安医疗健康管理股份有限公司 | 文档格式转换方法、装置、设备及可读存储介质 |
| CN111399900A (zh) * | 2020-03-10 | 2020-07-10 | 山东汇贸电子口岸有限公司 | 一种基于python与正则表达式的API文档自动生成方法及系统 |
| CN112130830A (zh) * | 2020-08-25 | 2020-12-25 | 汉海信息技术(上海)有限公司 | 接口生成方法、装置及电子设备 |
| CN112130830B (zh) * | 2020-08-25 | 2024-03-19 | 汉海信息技术(上海)有限公司 | 接口生成方法、装置及电子设备 |
| CN111930635B (zh) * | 2020-09-17 | 2021-06-29 | 深圳微品致远信息科技有限公司 | 基于swagger快速自动化测试的方法及系统 |
| CN111930635A (zh) * | 2020-09-17 | 2020-11-13 | 深圳微品致远信息科技有限公司 | 基于swagger快速自动化测试的方法及系统 |
| CN112631694A (zh) * | 2020-12-11 | 2021-04-09 | 远光软件股份有限公司 | 一种api接口封装调用方法及系统 |
| CN112631694B (zh) * | 2020-12-11 | 2023-08-11 | 远光软件股份有限公司 | 一种api接口封装调用方法及系统 |
| CN112860551A (zh) * | 2021-02-02 | 2021-05-28 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
| CN112860551B (zh) * | 2021-02-02 | 2024-04-30 | 浪潮云信息技术股份公司 | 一种基于api网关实现在线调试和文档导出的方法 |
Similar Documents
| Publication | Publication Date | Title |
|---|---|---|
| CN110196733A (zh) | 一种预设api文档生成方法、装置、设备和存储介质 | |
| CN103279373B (zh) | 浏览器外壳功能的更新方法及装置 | |
| US7610545B2 (en) | Annotations for tracking provenance | |
| CN108287694A (zh) | 应用程序构建方法、系统、计算机设备和存储介质 | |
| US20090204883A1 (en) | Method, Program and System for the Dynamic, Template-Based Generation of Internet Pages | |
| CN108228180A (zh) | 基于可视化界面设计的自动代码生成方法及系统 | |
| US20080007779A1 (en) | Method and system for generating executable code for formatting and printing complex data structures | |
| CN105893014A (zh) | 用于前端的项目开发方法及系统 | |
| CN108920496B (zh) | 一种渲染方法及装置 | |
| CN110968294B (zh) | 一种业务领域模型建立系统及方法 | |
| CN110968317B (zh) | 一种通过UCI/USI配置文件自动生成vue页面组件的方法和系统 | |
| CN105589959A (zh) | 表单处理方法和表单系统 | |
| CN108170409B (zh) | Web前端控件的开发方法和系统 | |
| CN107506190A (zh) | 基于Spring框架的XML文件修改方法及装置 | |
| CN111078217A (zh) | 脑图生成方法、装置和计算机可读存储介质 | |
| CN112799670B (zh) | 一种统一多端逻辑开发的方法及系统 | |
| CN110187886A (zh) | 一种文档网站生成方法及终端 | |
| CN111142861B (zh) | 结构化综控系统集成方法及装置 | |
| CN111311461B (zh) | 基于b-s的结构化动态病历表单的编辑器及生成方法 | |
| CN113204340A (zh) | 题目生产方法、题目管理系统及电子设备 | |
| CN110162299A (zh) | web程序及其快速开发框架、开发方法与相关设备 | |
| CN115562989A (zh) | 一种自动化测试序列转化方法、系统、设备和介质 | |
| Gilmore | Easy Laravel 5 | |
| Bandelloni et al. | Reverse engineering cross-modal user interfaces for ubiquitous environments | |
| CN113971024B (zh) | 接口管理方法、装置、电子设备以及可读存储介质 |
Legal Events
| Date | Code | Title | Description |
|---|---|---|---|
| PB01 | Publication | ||
| PB01 | Publication | ||
| SE01 | Entry into force of request for substantive examination | ||
| SE01 | Entry into force of request for substantive examination | ||
| RJ01 | Rejection of invention patent application after publication | ||
| RJ01 | Rejection of invention patent application after publication |
Application publication date: 20190903 |