CN116360849A - 接口文档的生成方法、装置、计算机设备及可读存储介质 - Google Patents

Abstract

本发明公开了一种接口文档的生成方法、装置、计算机设备及可读存储介质，涉及数据处理领域，方法包括：获取目标应用的所有源代码文件和每个源代码文件对应的创作者信息数据；接着，针对每个源代码文件进行迭代循环，以确定源代码文件中的接口数据、请求传入参数及请求返回参数，并将接口数据、请求传入参数及请求返回参数保存至预设文档；将每个源代码文件对应的创作者信息数据保存至预设文档以得到目标应用对应的接口文档。基于此，本发明使得接口文档的生成得以自动化进行，由此能避免工作人员因文档生成工具不同或者是因为文档编写习惯不同而导致文档不规范的情况出现。

Description

接口文档的生成方法、装置、计算机设备及可读存储介质

技术领域

本发明涉及数据处理领域，尤其涉及一种接口文档的生成方法、装置、计算机设备及可读存储介质。

背景技术

在软件开发行业中，接口文档是不可获取的产物之一，但在接口文档的生成过程中，常因不同团队/人员的管理工具不同的和文档规范不同，导致不同的团队/人员生成接口文档难以被其他团队/人员使用。

由此，如何生成统一且规范的接口文档是当下各软件开发企业需解决的迫切问题之一。

发明内容

有鉴于此，本发明提供一种可应用于金融科技领域及其他科技领域的接口文档的生成方法、装置、计算机设备及可读存储介质，用于解决如何生成统一且规范的接口文档的问题。

第一方面，本发明实施例提供一种接口文档的生成方法，包括：

获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据；

针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型；

将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

可选的，在本发明实施例提供的一种可行方式中，所述获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据，包括：

获取所述目标应用的所有代码文件和每个所述源代码文件对应的创作者信息数据；

将所有所述代码文件中，文件名称包含contreller的代码文件作为源代码文件。

可选的，在本发明实施例提供的一种可行方式中，所述预设文档包括接口数据子文档、请求传入参数子文档及请求返回参数子文档；

所述针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，包括：

确定每个所述源代码文件中的所有接口数据；

确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数；

针对每个所述源代码文件，将所述源代码文件的所述接口数据保存至所述接口数据子文档，并将所述源代码文件的所述请求传入参数保存至所述请求传入参数子文档，及将所述源代码文件的所述请求返回参数保存至所述请求返回参数子文档。

可选的，在本发明实施例提供的一种可行方式中，所述确定每个所述源代码文件中的所有接口数据，包括：

针对每个所述源代码文件，搜索所述源代码文件中的每个RequestMapping注解，并提取每个所述RequestMapping注解对应的value值和method值；

针对每个所述RequestMapping注解，将所述RequestMapping注解对应的value值作为对应的接口的存储位置，及将所述RequestMapping注解对应的method值作为对应的接口的方法类型；

基于每个RequestMapping注解对应的接口的存储位置和方法类型得到接口数据。

可选的，在本发明实施例提供的一种可行方式中，所述确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数，包括：

针对每个所述源代码文件，搜索所述源代码文件中每个包含Request单词的参数传入代码和每个包含Response单词的方法代码，并确定每个所述参数传入代码对应的类；

将所述源代码文件对应的类的传入参数作为所述源代码文件的请求传入参数；

将所述源代码文件中的每个所述方法代码的返回参数作为所述源代码文件的请求返回参数。

可选的，在本发明实施例提供的一种可行方式中，所述方法还包括：

响应文档下载请求，将所述文档下载请求对应的目标接口文档发送所述文档下载请求对应的请求发起端。

可选的，在本发明实施例提供的一种可行方式中，所述将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，包括：

将所述接口数据、所述请求传入参数及所述请求返回参数与预设文档已存储的接口路径、请求传入参数及请求返回参数进行对应比较，若不一致则将所述接口路径、所述请求传入参数及所述请求返回参数存储至所述预设文档。

第二方面，本发明实施例提供一种接口文档的生成装置，包括：

获取模块，用于获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据；

确定模块，用于针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型；

存储模块，用于将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

第三方面，本发明实施例提供一种计算机设备，包括存储器以及处理器，存储器存储有计算机程序，计算机程序在处理器上运行时执行如第一方面中任一种公开的接口文档的生成方法。

第四方面，本发明实施例提供一种计算机可读存储介质，计算机可读存储介质上存储有计算机程序，计算机程序在处理器上运行时执行如第一方面中任一种公开的接口文档的生成方法。

本发明实施例提供的接口文档的生成方法中，首先获取目标应用的所有源代码文件以从源代码文件提取接口相关的数据/参数/信息，同时获取每个源代码文件对应的创作者信息数据；接着，针对每个源代码文件进行迭代循环，以检索/确定源代码文件中的接口数据、请求传入参数及请求返回参数，并将接口数据、请求传入参数及请求返回参数保存至预设文档；最后，将每个源代码文件对应的创作者信息数据保存至预设文档以得到目标应用对应的接口文档。基于此，本发明实施例使得接口文档的生成得以自动化进行，由此能避免工作人员因文档生成工具不同或者是因为文档编写习惯不同而导致文档不规范的情况出现，并且能免去工作人员编写/书写文档的时间，从而能提高工作人员的工作效率；同时，因接口文档中还包含每个源代码文件对应的创作者信息，故后期维护接口文档时，能基于源代码文件对应的创作者信息寻找对应的创造者的帮助，且方便追溯。

附图说明

为了更清楚地说明本发明的技术方案，下面将对实施例中所需要使用的附图作简单地介绍，应当理解，以下附图仅示出了本发明的某些实施例，因此不应被看作是对本发明保护范围的限定。在各个附图中，类似的构成部分采用类似的编号。

图1示出了本发明实施例提供的第一种接口文档的生成方法的流程示意图；

图2示出了本发明实施例提供的第二种接口文档的生成方法的流程示意图；

图3示出了本发明实施例提供的第三种接口文档的生成方法的流程示意图；

图4示出了本发明实施例提供的接口文档的生成装置的结构示意图。

具体实施方式

下面将结合本发明实施例中附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。

通常在此处附图中描述和示出的本发明实施例的组件可以以各种不同的配置来布置和设计。因此，以下对在附图中提供的本发明的实施例的详细描述并非旨在限制要求保护的本发明的范围，而是仅仅表示本发明的选定实施例。基于本发明的实施例，本领域技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。

在下文中，可在本发明的各种实施例中使用的术语“包括”、“具有”及其同源词仅意在表示特定特征、数字、步骤、操作、元件、组件或前述项的组合，并且不应被理解为首先排除一个或更多个其它特征、数字、步骤、操作、元件、组件或前述项的组合的存在或增加一个或更多个特征、数字、步骤、操作、元件、组件或前述项的组合的可能性。

此外，术语“第一”、“第二”、“第三”等仅用于区分描述，而不能理解为指示或暗示相对重要性。

除非另有限定，否则在这里使用的所有术语(包括技术术语和科学术语)具有与本发明的各种实施例所属领域普通技术人员通常理解的含义相同的含义。所述术语(诸如在一般使用的词典中限定的术语)将被解释为具有与在相关技术领域中的语境含义相同的含义并且将不被解释为具有理想化的含义或过于正式的含义，除非在本发明的各种实施例中被清楚地限定。

实施例1

参照图1，示出了本发明实施例提供的第一种接口文档的生成方法的流程示意图，本发明实施例提供的接口文档的生成方法，包括：

步骤S110，获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据。

也即，本发明实施例在生成目标应用/项目/软件对应的接口文档时，首先将获取存储目标应用对应的代码的文件，也即源代码文件。

需理解的是，接口(interface)指代未实例化的方法(method)或类(class)，接口包含多个成员变量，但各个成员变量均仅是声明而未被定义。

进一步的，本发明实施例中的接口文档指代目标应用中各个被使用函数或类的说明文档，用于说明各个接口调用时需遵循的规则。

还需理解的是，本发明实施例中的源代码文件为用于存储源代码的文件，在JAVA编辑环境中，源代码文件为后缀名为“.java”的文件。

进一步的，为使接口文档的后期维护和修改能高效地处理，故本发明实施例在获取源代码文件的同时，还获取其对应的创作者信息数据，也即，获取此源代码文件对应的创作者/作者的信息，此信息包括但不仅限于姓名和/或工号。

可选的，在本发明实施例提供的一种可行方式中，创作者信息数据的获取方式为：搜索源代码文件中标签Author对应的值，并将此值作为源代码文件对应的创作者信息数据。

进一步的，若标签Author对应的值为空或null，则在一种可行方式中，本发明实施例将获取目标应用对应的项目负责人的信息数据以作为源代码文件对应的创作者信息数据。

此外，因现有的软件开发过程中，进行软件开发的各个工作人员通常会将编写的代码上传至代码托管平台，因此，在一种可行方式中，本发明实施例将通过读取代码托管平台中的所有代码文件以得到源代码文件。

可选的，因接口通常是在控制器层中设计，即在contreller层中设计，故在本发明实施例提供的一种可行方式中，具体可参考图2，示出了本发明实施例提供第二种接口文档的生成方法的流程示意图，此种可行方式下前述步骤S110具体包括：

S111，获取所述目标应用的所有代码文件和每个所述源代码文件对应的创作者信息数据；

S112，将所有所述代码文件中，文件名称包含contreller的代码文件作为源代码文件。

也即，本发明实施例在获取到目标应用的所有代码文件后，将检索所有代码文件中的contreller文件下的源代码文件，即，名称包含单词“contreller”且后缀名为“.java”的文件。

步骤S120，针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型。

也即，本发明实施例循环遍历每个源代码文件，以确定源代码文件中各个接口的存储路径、方法类型、请求传入参数及请求返回参数，同时将源代码文件的中各个接口的存储路径、方法类型、请求传入参数及请求返回参数存储至预设文档，进而在后续过程中基于已存入上述存储路径、方法类型、请求传入参数及请求返回参数的预设文档来生成接口文档。

需理解的是，本发明实施例中的方法即method，亦可理解为函数(function)。方法类型包括get类型、post类型、put类型及delete类型。

另外，能够理解的是，从源代码文件中确定出各个接口的存储路径、方法类型、请求传入参数及请求返回参数的方式为可根据实际情况设置的内容。

步骤S130，将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

也即，本发明实施例在将源代码文件中各个接口的存储路径、方法类型、请求传入参数及请求返回参数存入预设文档后，还将源代码文件对应的创作者信息数据一并存储至预设文档中，进而在完成接口文档生成后，后续的运维人员还能根据源代码文件对应的创作者信息数据，寻求对应的创作者/工作人员的帮助，进而高效地完成文档维护。

基于此，本发明实施例使得接口文档的生成自动化，由此能避免因文档生成工具不同或者是因为文档编写习惯不同而导致文档不规范的情况出现，并且能免去工作人员编写/书写文档的时间，从而能提高工作人员的工作效率；同时，因接口文档中还包含每个源代码文件对应的创作者信息，故后期维护接口文档时，能基于源代码文件对应的创作者信息寻找对应的创造者的帮助，且方便追溯。

可选的，在本发明实施例提供的一种可行方式中，具体可参考图3，示出了本发明实施例提供的第三种接口文档的生成方法的流程示意图，此种可行方式下，所述预设文档包括接口数据子文档、请求传入参数子文档及请求返回参数子文档；

进而，上述步骤S120在此种可行方式下具体包括：

步骤S121，确定每个所述源代码文件中的所有接口数据；

步骤S122，确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数；

步骤S123，针对每个所述源代码文件，将所述源代码文件的所述接口数据保存至所述接口数据子文档，并将所述源代码文件的所述请求传入参数保存至所述请求传入参数子文档，及将所述源代码文件的所述请求返回参数保存至所述请求返回参数子文档。

也即，本发明实施例在遍历各个源代码文件的过程中，首先将查询到源代码文件中的所有接口数据，并查询源代码文件中的所有请求传入参数和所有请求返回参数；最后将每个源代码文件中的所有接口数据、所有请求传入参数及所有请求返回参数分别保存至预设文档中的不同区域，具体的，接口数据保存至接口数据子文档，请求传入参数保存至请求传入参数子文档，请求返回参数保存至请求返回参数子文档。

由此，基于分区域的接口各类参数的保存，使得接口文档的存储更规范，参数存储逻辑更清晰明了，也因此，使得其他工作人员能更简单地理解接口文档中的信息。

可选的，上述步骤S121在本发明实施例提供的一种可行方式中具体包括：

针对每个所述源代码文件，搜索所述源代码文件中的每个RequestMapping注解，并提取每个所述RequestMapping注解对应的value值和method值；

针对每个所述RequestMapping注解，将所述RequestMapping注解对应的value值作为对应的接口的存储位置，及将所述RequestMapping注解对应的method值作为对应的接口的方法类型；

基于每个RequestMapping注解对应的接口的存储位置和方法类型得到接口数据。

也即，本发明实施例在遍历各个源代码文件的过程中，将检索源代码文件中的每个RequestMapping注解，也即检索“@RequestMapping”。可以理解的是，RequestMapping注解通常包括“name”、“value”、“method”、“params”、“headers”、“consumes”及“produces”共计6个属性，其中，“value”属性表示表示类或方法对应的URL(Uniform Resource Locator，统一资源定位系统)映射，即类或方法对应的存储路径；而“method”属性则是规定请求的类型，即接口的方法类型，包括get类型、post类型、put类型及delete类型。

基于此，本发明实施例在确定RequestMapping注解后，将对应提取RequestMapping注解中的value属性/值和method属性/值，并将value值作为接口对应的存储路径，method值作为接口对应的方法类型，进而得到接口对应的接口数据。

可选的，上述步骤S122在本发明实施例提供的一种可行方式中具体包括：

针对每个所述源代码文件，搜索所述源代码文件中每个包含Request单词的参数传入代码和每个包含Response单词的方法代码，并确定每个所述参数传入代码对应的类；

将所述源代码文件对应的类的传入参数作为所述源代码文件的请求传入参数；

将所述源代码文件中的每个所述方法代码的返回参数作为所述源代码文件的请求返回参数。

也即，在迭代遍历每个源代码文件的过程中，除检索接口数据外，本发明实施例还将查找包含“Request”字样的请求传入参数，并获取此请求传入参数对应的类(class)，及提取类(class)中的传入参数，进而得到源代码文件的请求传入参数。

而在检索包含“Request”字样/单词的请求传入参数的同时，还将检索此源代码文件中包含“Response”字样/单词的方法名对应的代码，即方法代码；然后搜索此方法代码对应的返回值，即可得到源代码文件的请求返回参数。

可选的，一种可选方式中，本发明实施例将在得到源代码文件的请求传入参数或请求返回参数时，立即将请求传入参数或请求返回参数存储至对应的请求传入参数子文档或请求返回参数子文档。也即，在对遍历各个源代码文件的过程中，针对每个源代码文件，本发明实施例将在检索到接口数据、请求传入参数及请求返回参数中的任一种时，立即将其存储至对应的文档，不再等待接口数据、请求传入参数及请求返回参数三者均已被检索/获取到时再分别执行存储操作，由此提高文档的生成效率。

可选的，在本发明实施例提供的一种可行方式中，所述方法还包括：

响应文档下载请求，将所述文档下载请求对应的目标接口文档发送所述文档下载请求对应的请求发起端。

也即，在生成接口文档后，本发明实施例将基于已生成的接口文档响应各个外部下载请求/文档下载请求，即文档下载请求对应的目标接口文档发送至文档下载请求的请求发起端，由此满足接口文档导出需求。

可选的，上述步骤S120中的“将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档”在本发明实施例提供的一种可行方式中具体包括：

将所述接口数据、所述请求传入参数及所述请求返回参数与预设文档已存储的接口路径、请求传入参数及请求返回参数进行对应比较，若不一致则将所述接口路径、所述请求传入参数及所述请求返回参数存储至所述预设文档。

也即，本发明实施例为避免同一个源代码文件的参数/信息/数据被重复存储，故在将待存储源代码文件的接口数据、请求传入参数及请求返回参数存储至预设文档中时，还将判断源代码文件的接口数据、请求传入参数及请求返回参数与预设文档中已存储的数据是否一致，若不一致，则将源代码文件的接口数据、请求传入参数及请求返回参数存储。若一致，则表明源代码文件的接口数据、请求传入参数及请求返回参数已存储过，故放弃此源代码文件的相关接口信息/数据存储，从而避免重复存储导致的存储空间浪费和冗余。

实施例2

与本发明实施例1提供的接口文档的生成方法相对应的，本发明实施例2还提供一种接口文档的生成装置，参照图4，示出了本发明实施例提供的接口文档的生成装置的结构示意图，本发明实施例提供的接口文档的生成装置200，包括：

获取模块210，用于获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据；

确定模块220，用于针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型；

存储模块230，用于将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

可选的，在本发明实施例提供的一种可行方式中，所述获取模块，包括：

文件获取子模块，用于获取所述目标应用的所有代码文件和每个所述源代码文件对应的创作者信息数据；

文件确定子模块，用于将所有所述代码文件中，文件名称包含contreller的代码文件作为源代码文件。

可选的，在本发明实施例提供的一种可行方式中，所述预设文档包括接口数据子文档、请求传入参数子文档及请求返回参数子文档；

进而，所述确定模块，包括：

接口数据确定子模块，用于确定每个所述源代码文件中的所有接口数据；

参数确定子模块，用于确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数；

保存子模块，用于针对每个所述源代码文件，将所述源代码文件的所述接口数据保存至所述接口数据子文档，并将所述源代码文件的所述请求传入参数保存至所述请求传入参数子文档，及将所述源代码文件的所述请求返回参数保存至所述请求返回参数子文档。

可选的，在本发明实施例提供的一种可行方式中，所述接口数据确定子模块，包括：

提取单元，用于针对每个所述源代码文件，搜索所述源代码文件中的每个RequestMapping注解，并提取每个所述RequestMapping注解对应的value值和method值；

位置确定单元，用于针对每个所述RequestMapping注解，将所述RequestMapping注解对应的value值作为对应的接口的存储位置，及将所述RequestMapping注解对应的method值作为对应的接口的方法类型；

数据得到单元，用于基于每个RequestMapping注解对应的接口的存储位置和方法类型得到接口数据。

可选的，在本发明实施例提供的一种可行方式中，所述参数确定子模块，包括：

类确定单元，用于针对每个所述源代码文件，搜索所述源代码文件中每个包含Request单词的参数传入代码和每个包含Response单词的方法代码，并确定每个所述参数传入代码对应的类；

传入参数确定单元，用于将所述源代码文件对应的类的传入参数作为所述源代码文件的请求传入参数；

返回参数确定单元，用于将所述源代码文件中的每个所述方法代码的返回参数作为所述源代码文件的请求返回参数。

可选的，在本发明实施例提供的一种可行方式中，所述装置还包括：

响应文档下载请求，将所述文档下载请求对应的目标接口文档发送所述文档下载请求对应的请求发起端。

可选的，在本发明实施例提供的一种可行方式中，所述确定模块，包括：

比较子模块，用于将所述接口数据、所述请求传入参数及所述请求返回参数与预设文档已存储的接口路径、请求传入参数及请求返回参数进行对应比较，若不一致则将所述接口路径、所述请求传入参数及所述请求返回参数存储至所述预设文档。

本申请实施例提供的接口文档的生成装置200能够实现实施例1对应的接口文档的生成方法的各个过程，且能达到相同的技术效果，为避免重复，这里不再赘述。

本发明实施例还提供一种计算机设备，包括存储器以及处理器，存储器存储有计算机程序，计算机程序在处理器上运行时执行如实施例1对应的接口文档的生成方法。

本发明实施例还提供一种计算机可读存储介质，计算机可读存储介质上存储有计算机程序，计算机程序在处理器上运行时执行如实施例1对应的接口文档的生成方法。

在本申请所提供的几个实施例中，应该理解到，所揭露的装置和方法，也可以通过其它的方式实现。以上所描述的装置实施例仅仅是示意性的，例如，附图中的流程图和结构图显示了根据本发明的多个实施例的装置、方法和计算机程序产品的可能实现的体系架构、功能和操作。在这点上，流程图或框图中的每个方框可以代表一个模块、程序段或代码的一部分，所述模块、程序段或代码的一部分包含一个或多个用于实现规定的逻辑功能的可执行指令。也应当注意，在作为替换的实现方式中，方框中所标注的功能也可以以不同于附图中所标注的顺序发生。例如，两个连续的方框实际上可以基本并行地执行，它们有时也可以按相反的顺序执行，这依所涉及的功能而定。也要注意的是，结构图和/或流程图中的每个方框、以及结构图和/或流程图中的方框的组合，可以用执行规定的功能或动作的专用的基于硬件的系统来实现，或者可以用专用硬件与计算机指令的组合来实现。

另外，在本发明各个实施例中的各功能模块或单元可以集成在一起形成一个独立的部分，也可以是各个模块单独存在，也可以两个或更多个模块集成形成一个独立的部分。

所述功能如果以软件功能模块的形式实现并作为独立的产品销售或使用时，可以存储在一个计算机可读取存储介质中。基于这样的理解，本发明的技术方案本质上或者说对现有技术做出贡献的部分或者该技术方案的部分可以以软件产品的形式体现出来，该计算机软件产品存储在一个存储介质中，包括若干指令用以使得一台计算机设备(可以是智能手机、个人计算机、服务器、或者网络设备等)执行本发明各个实施例所述方法的全部或部分步骤。而前述的存储介质包括：U盘、移动硬盘、只读存储器(ROM，Read-Only Memory)、随机存取存储器(RAM，Random Access Memory)、磁碟或者光盘等各种可以存储程序代码的介质。

以上所述，仅为本发明的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到变化或替换，都应涵盖在本发明的保护范围之内。

Claims (10)

1.一种接口文档的生成方法，其特征在于，包括：

获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据；

针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型；

将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

2.根据权利要求1所述的接口文档的生成方法，其特征在于，所述获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据，包括：

获取所述目标应用的所有代码文件和每个所述源代码文件对应的创作者信息数据；

将所有所述代码文件中，文件名称包含contreller的代码文件作为源代码文件。

3.根据权利要求1所述的接口文档的生成方法，其特征在于，所述预设文档包括接口数据子文档、请求传入参数子文档及请求返回参数子文档；

所述针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，包括：

确定每个所述源代码文件中的所有接口数据；

确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数；

针对每个所述源代码文件，将所述源代码文件的所述接口数据保存至所述接口数据子文档，并将所述源代码文件的所述请求传入参数保存至所述请求传入参数子文档，及将所述源代码文件的所述请求返回参数保存至所述请求返回参数子文档。

4.根据权利要求3所述的接口文档的生成方法，其特征在于，所述确定每个所述源代码文件中的所有接口数据，包括：

针对每个所述源代码文件，搜索所述源代码文件中的每个RequestMapping注解，并提取每个所述RequestMapping注解对应的value值和method值；

针对每个所述RequestMapping注解，将所述RequestMapping注解对应的value值作为对应的接口的存储位置，及将所述RequestMapping注解对应的method值作为对应的接口的方法类型；

基于每个RequestMapping注解对应的接口的存储位置和方法类型得到接口数据。

5.根据权利要求3所述的接口文档的生成方法，其特征在于，所述确定每个所述源代码文件中的所有请求传入参数和所有请求返回参数，包括：

针对每个所述源代码文件，搜索所述源代码文件中每个包含Request单词的参数传入代码和每个包含Response单词的方法代码，并确定每个所述参数传入代码对应的类；

将所述源代码文件对应的类的传入参数作为所述源代码文件的请求传入参数；

将所述源代码文件中的每个所述方法代码的返回参数作为所述源代码文件的请求返回参数。

6.根据权利要求1所述的接口文档的生成方法，其特征在于，所述方法还包括：

响应文档下载请求，将所述文档下载请求对应的目标接口文档发送所述文档下载请求对应的请求发起端。

7.根据权利要求1所述的接口文档的生成方法，其特征在于，所述将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，包括：

将所述接口数据、所述请求传入参数及所述请求返回参数与预设文档已存储的接口路径、请求传入参数及请求返回参数进行对应比较，若不一致则将所述接口路径、所述请求传入参数及所述请求返回参数存储至所述预设文档。

8.一种接口文档的生成装置，其特征在于，包括：

获取模块，用于获取目标应用的所有源代码文件和每个所述源代码文件对应的创作者信息数据；

确定模块，用于针对每个所述源代码文件，确定所述源代码文件中的接口数据、请求传入参数及请求返回参数，并将所述接口数据、所述请求传入参数及所述请求返回参数保存至预设文档，其中，所述接口数据包括接口的存储位置和所述接口的方法类型；

存储模块，用于将每个所述源代码文件对应的创作者信息数据保存至所述预设文档以得到所述目标应用对应的接口文档。

9.一种计算机设备，其特征在于，包括存储器以及处理器，所述存储器存储有计算机程序，所述计算机程序在所述处理器上运行时执行如权利要求1-7任一项所述的接口文档的生成方法。

10.一种计算机可读存储介质，其特征在于，所述计算机可读存储介质上存储有计算机程序，所述计算机程序在处理器上运行时执行如权利要求1-7任一项所述的接口文档的生成方法。

Images