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

本申请提供了一种接口文档的生成方法及装置。在执行该方法时，先获取目标业务对应的目标代码文件；接着利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息，然后根据所述目标业务平台的参数，确定适配器类中所述目标业务平台对应的目标子适配器；最后利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档。这样一来，通过将目标业务对应的目标代码文件进行解析，得到目标代码文件对应的目标特征信息后，可在适配器中根据目标业务平台的格式过滤特征信息，从而生成目标业务对应的接口文档，提高接口文档的生成效率，进而提高开发效率。进而提高开发效率。进而提高开发效率。

【技术实现步骤摘要】
一种接口文档的生成方法及装置


[0001]本申请涉及计算机应用领域，尤其涉及一种接口文档的生成方法及装置。

技术介绍

[0002]接口文档，顾名思义就是接口的说明文档，它是调用接口的依据。接口文档包含了对接口URL，参数以及输出内容的说明，参照接口文档就能方便的知道接口的作用，以及接口如何进行调用。
[0003]目前，国内流行的文档生成工具Swagger，能够在线自动生成接口文档。
[0004]但是由于Swagger接口文档内容单一，对于需要多类格式的接口文档并不友好，例如swagger对于接口文档格式要求严格的自动化平台或者压测平台仍需要做诸多改动，使得接口文档的生成效率低下，进而影响开发效率。

技术实现思路

[0005]有鉴于此，本申请提供了一种接口文档的生成方法及装置，旨在提高接口文档的生成效率，进而提高开发效率。
[0006]第一方面，本申请实施例提供了一种接口文档的生成方法，所述方法包括：
[0007]获取目标业务对应的目标代码文件；所述目标业务包括业务参数，所述业务参数用于指示所述目标业务对应的目标业务平台；
[0008]利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息；
[0009]根据所述目标业务平台的参数，确定适配器类中所述目标业务平台对应的目标子适配器；所述目标业务平台的参数用于指示所述目标业务平台的格式，所述适配器类中包括多个子适配器，每个子适配器用于根据不同业务平台的格式，确定不同业务平台所需的特征信息；
[0010]利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档。
[0011]可选地，所述预设的解析器是基于Javadoc注释规范文档编写的。
[0012]可选地，所述利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息，包括：
[0013]利用预设的解析器遍历所述目标代码文件，得到所述目标代码文件对应的多个特征字符信息；
[0014]对所述多个所述特征字符信息中每个特征字符信息进行解析，得到所述目标代码文件中每个特征字符信息对应的特征信息。
[0015]可选地，在利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档之前，所述方法还包括：
[0016]所述适配器类将所述目标特征信息路由到对应的目标子适配器。
[0017]可选地，在生成所述目标业务对应的接口文档之后，所述方法还包括：
[0018]基于所述接口文档，利用预设脚本，生成所述接口文档对应的离线接口文档。
[0019]可选地，在生成所述接口文档对应的离线接口文档之后，所述方法还包括：
[0020]将所述接口文档对应的离线接口文档导入到所述目标业务平台。
[0021]第二方面，本申请实施例提供了一种接口文档的生成装置，所述装置包括：
[0022]获取模块，用于获取目标业务对应的目标代码文件；所述目标业务包括业务参数，所述业务参数用于指示所述目标业务对应的目标业务平台；
[0023]解析模块，用于利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息；
[0024]确定模块，用于根据所述目标业务平台的参数，确定适配器类中所述目标业务平台对应的目标子适配器；所述目标业务平台的参数用于指示所述目标业务平台的格式，所述适配器类中包括多个子适配器，每个子适配器用于根据不同业务平台的格式，确定不同业务平台所需的特征信息；
[0025]第一生成模块，用于利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档。
[0026]可选地，所述解析模块，具体用于利用预设的解析器遍历所述目标代码文件，得到所述目标代码文件对应的多个特征字符信息；
[0027]对所述多个所述特征字符信息中每个特征字符信息进行解析，得到所述目标代码文件中每个特征字符信息对应的特征信息。
[0028]可选地，在生成所述目标业务对应的接口文档之后，所述装置还包括：
[0029]第二生成模块，用于基于所述接口文档，利用预设脚本，生成所述接口文档对应的离线接口文档。
[0030]第三方面，本申请提供了一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现以上任意一项所述方法。
[0031]上述技术方案具有如下有益效果：
[0032]本申请提供了一种接口文档的生成方法及装置。在执行所述方法时，先获取目标业务对应的目标代码文件；其中，所述目标业务包括业务参数，所述业务参数用于指示所述目标业务对应的目标业务平台，接着利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息，然后根据所述目标业务平台的参数，确定适配器类中所述目标业务平台对应的目标子适配器；其中，所述目标业务平台的参数用于指示所述目标业务平台的格式，所述适配器类中包括多个子适配器，每个子适配器用于根据不同业务平台的格式，确定不同业务平台所需的特征信息；最后利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档。这样一来，通过将目标业务对应的目标代码文件进行解析，得到目标代码文件对应的目标特征信息后，可在适配器中根据目标业务平台的格式过滤特征信息，从而生成目标业务对应的接口文档，提高接口文档的生成效率，进而提高开发效率。
附图说明
[0033]为更清楚地说明本实施例或现有技术中的技术方案，下面将对实施例或现有技术
描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。
[0034]图1为本申请实施例提供的接口文档的生成方法的一种方法流程图；
[0035]图2为本申请实施例提供的接口文档的生成装置的一种结构示意图。
具体实施方式
[0036]下面将结合本专利技术实施例中的附图，对本专利技术实施例中的技术方案进行清楚、完整地描述。显然，所描述的实施例仅是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。
[0037]本申请实施例中相关术语介绍如下：
[0038]Javadoc：javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。
[0039]应用程序界面(Application Program Interface，API)：为应用程序可用以与计算机操作系统交换信息和命令的标准集。一个本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档的生成方法，其特征在于，所述方法包括：获取目标业务对应的目标代码文件；所述目标业务包括业务参数，所述业务参数用于指示所述目标业务对应的目标业务平台；利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息；根据所述目标业务平台的参数，确定适配器类中所述目标业务平台对应的目标子适配器；所述目标业务平台的参数用于指示所述目标业务平台的格式，所述适配器类中包括多个子适配器，每个子适配器用于根据不同业务平台的格式，确定不同业务平台所需的特征信息；利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档。2.根据权利要求1所述的方法，其特征在于，所述预设的解析器是基于Javadoc注释规范文档编写的。3.根据权利要求1所述的方法，其特征在于，所述利用预设的解析器，对所述目标代码文件进行解析，得到所述目标代码文件对应的目标特征信息，包括：利用预设的解析器遍历所述目标代码文件，得到所述目标代码文件对应的多个特征字符信息；对所述多个所述特征字符信息中每个特征字符信息进行解析，得到所述目标代码文件中每个特征字符信息对应的特征信息。4.根据权利要求1所述的方法，其特征在于，在利用所述目标子适配器对所述目标特征信息进行过滤，生成所述目标业务对应的接口文档之前，所述方法还包括：所述适配器类将所述目标特征信息路由到对应的目标子适配器。5.根据权利要求1所述的方法，其特征在于，在生成所述目标业务对应的接口文档之后，所述方法还包括：基于所述接口文档，利用预设脚本，生成所述接口文档对应的离线接口文档。6.根据权利要求5所...

【专利技术属性】
技术研发人员：张鑫，
申请(专利权)人：湖南快乐阳光互动娱乐传媒有限公司，
类型：发明
国别省市：