CN111880778A - 接口文档的生成方法、装置、电子设备及存储介质 - Google Patents

Abstract

本申请公开了一种接口文档的生成方法、装置、电子设备及存储介质，涉及网关技术领域，可用于云平台或云服务。具体实现方案为：从仓库中下载应用程序接口资源包；对应用程序接口资源包进行解析，获取接口文档的元信息；基于接口文档的元信息，生成所述接口文档。与现有技术相比，本申请不用开发人员手动编写接口文档，可以自动地实现接口文档的生成，能够有效地保证接口文档生成的准确性。而且避免后端开发人员手动编写接口文档，能够有效地节省人力，缩短接口文档的生成时间，提高接口文档的生成效率。

Description

接口文档的生成方法、装置、电子设备及存储介质

技术领域

本申请涉及计算机技术，尤其涉及网关技术领域，具体涉及一种接口文档的生成方法、装置、电子设备及存储介质。

背景技术

现有的网络中的资源业务系统大多采用分布式微服务来实现，具体由多个后端服务模块组成。这些后端服务模块都需要统一的网关来对外输出，以完成鉴权、流控、熔断等基础功能。例如，用户使用时，可以通过浏览器或者客户端等前端使用资源业务系统。前端与网关通过文本协议(如JSON)进行交互，而网关与后端服务模块均部署在企业内网，二者通过性能更高的二进制协议(如ProtoBuf)进行交互。

两种协议之间需要关于schema的翻译机制，即在前后端协同开发中，开发人员需要手动编写一份定义类的接口文档，用来描述接口信息，实现前端接口到后端接口的翻译。现有技术中，每当业务变更、服务升级时，都需要后端开发人员按照升级后的代码，手动编写接口文档。

但是，后端开发人员手动编写接口文档，极易出现编写错误，导致接口文档的准确性较低。

发明内容

为了解决上述技术问题，本申请提供了一种接口文档的生成方法、装置、电子设备及存储介质。

根据本申请的一方面，提供了一种接口文档的生成方法，其中，所述方法包括：

从仓库中下载应用程序接口资源包；

对所述应用程序接口资源包进行解析，获取接口文档的元信息；

基于所述接口文档的元信息，生成所述接口文档。

根据本申请的另一方面，提供了一种应用程序接口资源包的处理方法，其中，所述方法包括：

获取开发的应用程序接口资源包；

在所述应用程序接口资源包中设置埋点信息；

向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

根据本申请的再一方面，提供了一种接口文档的生成装置，其中，所述装置包括：

下载模块，用于从仓库中下载应用程序接口资源包；

解析模块，用于对所述应用程序接口资源包进行解析，获取接口文档的元信息；

生成模块，用于基于所述接口文档的元信息，生成所述接口文档。

根据本申请的又一方面，提供了一种应用程序接口资源包的处理装置，其中，所述装置包括：

获取模块，用于获取开发的应用程序接口资源包；

设置模块，用于在所述应用程序接口资源包中设置埋点信息；

上传模块，用于向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

根据本申请的再另一方面，提供了一种电子设备，包括：

至少一个处理器；以及

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行如上所述的方法。

根据本申请的再又一方面，提供了一种存储有计算机指令的非瞬时计算机可读存储介质，所述计算机指令用于使所述计算机执行如上所述的方法。

根据本申请的技术可以提高接口文档的生成效率。

应当理解，本部分所描述的内容并非旨在标识本公开的实施例的关键或重要特征，也不用于限制本公开的范围。本公开的其它特征将通过以下的说明书而变得容易理解。

附图说明

附图用于更好地理解本方案，不构成对本申请的限定。其中：

图1是根据本申请第一实施例的示意图；

图2是图1所生成的接口文档的应用的架构图；

图3是根据本申请第二实施例的示意图；

图4是图3中的API资源包的抽象结构示意图；

图5是根据本申请第三实施例的示意图；

图6是根据本申请第四实施例的示意图；

图7是根据本申请第五实施例的示意图；

图8是根据本申请第六实施例的示意图；

图9是用来实现本申请实施例的上述方法的电子设备的框图。

具体实施方式

以下结合附图对本申请的示范性实施例做出说明，其中包括本申请实施例的各种细节以助于理解，应当将它们认为仅仅是示范性的。因此，本领域普通技术人员应当认识到，可以对这里描述的实施例做出各种改变和修改，而不会背离本申请的范围和精神。同样，为了清楚和简明，以下的描述中省略了对公知功能和结构的描述。

图1是根据本申请第一实施例的示意图；如图1所示，本实施例提供一种接口文档的生成方法，具体可以包括如下步骤：

S101、从仓库中下载应用程序接口(Application Programming Interface；API)资源包；

S102、对API资源包进行解析，获取接口文档的元信息；

S103、基于接口文档的元信息，生成接口文档。

本实施例的接口文档的生成方法的执行主体为接口文档的生成装置，该接口文档的生成装置可以为一实体的电子设备，或者也可以采用软件集成的应用，使用时，基于从仓库下载的API资源包，生成对应的接口文档。

图2是图1所生成的接口文档的应用的架构图。如图2所示，在分布式微服务的资源业务系统如广告业务系统中，具体由多个后端服务模块来提供资源业务，这些后端服务模块都需要统一的网关来对外输出，以完成鉴权、流控、熔断等基础功能。例如图2所示实施例中，以用户通过浏览器使用资源业务系统为例，浏览器与网关之间通过文本协议进行交互，而网关与后端服务模块均部署在企业内网，二者通过性能更高的二进制协议进行交互。图2所示的网关可以应用于云平台或云服务中。

本实施例所生成的接口文档也用于描述网关中API模块的接口到后端服务模块的接口的描述信息。即该接口文档与网关中的API模块具有相类似的功能，均用于描述接口信息，可以实现前端接口到后端接口的两种协议之间的翻译。但是接口文档和API模块的面向对象和形式不同。具体地，接口文档是面向开发人员，具体可以为一个网页或者是一个work文档。是供开发人员阅读的，开发人员通过调用并查看该接口文档，可以查询接口信息。而API模块是一些Java代码，是面向机器的，供机器读取的，通过调用该API模块可以实现前端接口到后端服务模块的接口的转换，实现前端对后端服务模块的访问。

本实施例的分布式微服务系统可以为广告业务系统或者其他资源业务系统。

在本申请的一实施例中，后端服务研发人员基于后断服务模块的升级，可以配置升级后的API资源包，也可以称之为Jar包。然后由后端服务研发人员将配置的API资源包上传至仓库。本实施例的仓库可以为Maven仓库，可以用于存储使用该分布式微服务系统的服务提供商的所有资源包。

本实施例的接口文档的生成装置可以为一独立的用于管理网关中所有接口文档的装置，该接口文档的装置可以与仓库进行通信。在需要生成接口文档时，从仓库中下载API资源包，然后对该API资源包进行解析，获取其中的生成接口文档所需的元信息。最后基于获取的生成该接口文档所需的所有元信息，生成对应的接口文档。

本实施例的接口文档的生成方法，通过从仓库中下载API资源包；对应用程序接口资源包进行解析，获取接口文档的元信息；基于接口文档的元信息，生成接口文档，与现有技术相比，不用开发人员手动编写接口文档，可以自动地实现接口文档的生成，能够有效地保证接口文档生成的准确性。而且避免后端开发人员手动编写接口文档，能够有效地节省人力，缩短接口文档的生成时间，提高接口文档的生成效率。

图3是根据本申请第二实施例的示意图；如图3所示，本实施例的接口文档的生成方法，在上述图1所示实施例的技术方案的基础上，进一步更加详细地介绍本申请的技术方案。如图3所示，本实施例的接口文档的生成方法，具体可以包括如下步骤：

S301、从仓库中下载API资源包；

S302、对API资源包进行解析，获取方法分类集合的信息；

S303、对API资源包进行解析，获取方法分类集合中的方法的信息；

S304、对API资源包进行解析，获取方法中的参数信息；

本实施例的步骤S302-S304为上述图1所示实施例的步骤S102的一种具体实现方式。

S305、基于解析到的API资源包中的方法分类集合、方法分类集合中的方法以及方法中的参数信息，生成接口文档。

即，步骤S305为上述图1所实施例的步骤S103的一种具体实现方式。基于解析获取到的所有信息，生成接口文档即可。

本实施例中，生成的接口文档，可以通过HTTP接口暴露给浏览器，用户即可通过浏览器方便快捷查询接口文档。

需要说明的是，本实施例中，一个API资源包中可以包括一个、两个或者多个方法分类集合。而每个方法分类集合中也可以包括一个、两个或者多个方法。在每个方法中，还可以进一步包括有参数信息，本实施例的解析，最终要获取到每一个参数信息。例如每一个方法中可以包括请求类型和返回类型的信息，在请求类型和返回类型的信息中包括有参数的信息，或者循环嵌套有参数的信息。本实施例的解析时要将请求类型和返回类型的嵌套的或者循环嵌套的参数信息解析出来。

实际应用中，可以按照上述步骤对API资源包进行解析，逐步获取其中的方法分类集合的信息、方法分类集合中的方法的信息、以及方法中的参数信息。

进一步可选地，上述解析过程需要对API资源包的每个信息做分析，解析效率较低。为了进一步提高解析效率，在API资源包中可以预设方法分类集合的埋点信息。这样，在步骤302实施时，可以基于预设的方法分类集合的埋点信息，对API资源包进行解析，获取方法分类集合的信息。例如，本实施例中，预设方法分类集合的埋点信息可以通过在生成API资源包时，在方法分类集合的位置处增加注解标记@APIService，以对方法分类集合做标记。这样，在解析时，可以基于预设的注解标记@APIService，获取相应的方法分类集合的信息。

上述在API资源包中方法分类集合的位置处增加注解标记@APIService仅为本实施例的一种实现方式，实际应用中，还可以根据具体需求设置不同形式的方法分类集合的埋点信息，在此不再一一举例赘述。

同理，进一步可选地，为了进一步提高解析效率，还可以在API资源包中可以预设方法的埋点信息。这样，在步骤303实施时，可以基于预设的方法的埋点信息，对API资源包进行解析，获取方法的信息。例如，本实施例中，预设方法的埋点信息可以通过在生成API资源包时，在方法的位置处增加注解标记@APIMethod，以对方法做标记。这样，在解析时，可以基于预设的注解标记@APIMethod，获取相应的方法的信息。

上述在API资源包中方法位置处增加注解标记@APIMethod仅为本实施例的一种实现方式，实际应用中，还可以根据具体需求设置不同形式的方法的埋点信息，在此不再一一举例赘述。

同理，进一步可选地，为了进一步提高解析效率，还可以在API资源包中可以预设参数的属性的埋点信息。这样，在步骤304实施时，可以先对API资源包进行解析，获取方法中的请求类型和返回类型的信息，即request类型和response类型的信息。然后进一步将请求类型的信息和返回类型的信息，分别作为实体(Entity)进行进一步解析，并基于预设的参数的属性的埋点信息，获取方法中的请求参数和返回参数的属性信息以及属性信息中包括的参数的属性信息。

例如，本实施例中，预设参数的属性的埋点信息可以通过在生成API资源包时，在参数的属性字段的位置处增加注解标记@APIParam，以对参数的属性字段做标记。这样，在解析时，可以基于预设的注解标记@APIParam，获取相应的参数的属性信息。

在一实施例中，获取方法的请求类型和返回类型的信息，分别作为entity进一步解析时：

若该entity的类型为泛型，则分别将泛型的rawType与genericType作为entity进一步进行递归解析；

若entity类型为泛型数组，则获取数组的元素，作为entity进一步递归解析；

若entity为普通Java类型，则获取该类型使用预设的埋点@APIParam标注的属性字段，作为entity进一步递归解析；

若entity为Java基础类型例如Integer、Long等等，递归解析结束，获取到请求类型和返回类型中包括的参数的属性信息，若参数中进一步嵌套有子类型，则通过递归解析，也能够获取到参数的属性信息中包括的参数的属性信息。

通过上述埋点信息的注解标记，可以得知，本实施例的接口文档的生成装置在生成接口文档的时候，可以将API资源包可以抽象为图4所示的结构示意图。如图4所示，可以将一个API资源包即Jar包中包含的信息抽象为N个service即方法分类集合，每个service中包含N个方法即method，每个method包含一个响应response类型类与N个请求request类型。其中request、response类型中可以包含子类型，子类型也可作为一个独立的Java类型包含更下层的子类型。并以此循环。接口文档生成装置定义了Entity类型来保存Java类型信息、Param类型来保存Java类型中的属性信息，例如，图4中以共包括N个Param为例。

本实施例的接口文档的生成装置，可以生成网关中任一API模块对应的接口文档。且在API模块升级时，都可以按照本实施例的方法自动生成接口文档。而且本实施例中，还可以统一管理各个API模块的各个版本的接口文档，使用非常方便。

本实施例的接口文档的生成方法，通过上述方案，可以基于预设的埋点信息，解析API资源包，获取其中的方法分类集合、方法分类集合中的方法以及方法中的参数信息，并最终基于解析获取到的信息生成接口文档。本实施例的技术方案，基于预设的埋点信息，对API资源包进行解析，不仅可以进一步提高生成的接口文档的准确性，同时还能够进一步提高接口文档的生成效率。

图5是根据本申请第三实施例的示意图；如图5所示，本实施例提供一种API资源包的处理方法，具体可以包括如下步骤：

S501、获取开发的API资源包；

S502、在API资源包中设置埋点信息；

S503、向仓库上传设置了埋点信息的API资源包，以供接口文档生成装置下载API资源包；基于设置的埋点信息对API资源包进行解析，获取接口文档的元信息；并基于接口文档的元信息，生成接口文档。

本实施例的API资源包的处理装置，可以为一独立的电子设备，或者也可以采用软件集成的应用，能够对API资源包进行处理。

例如，本实施例的API资源包的处理装置，可以分布式的设置在各后端服务模块中，或者可以与各后端服务模块通信，从各后端服务模块中获取开发的API资源包。

也就是说，优选地，后端服务开发人员在开发后端服务模块对应的API资源包时，可以基于后端服务模块的升级，在后端服务模块内完成对应的API资源包的开发。

API资源包的处理装置在获取到开发的API资源包后，可以在API资源包中设置埋点信息，并进一步向仓库上传设置了埋点信息的API资源包，以供接口文档生成装置下载API资源包，基于设置的埋点信息对API资源包进行解析，获取接口文档的元信息；并基于接口文档的元信息，生成接口文档。

可选地，本实施例中，在API资源包中设置埋点信息的时候，可以基于后端研发人员的触发，基于后端研发人员的设置要求，在API资源包中设置埋点信息。

或者可选地，还可以基于预设的规则，在API资源包中设置埋点信息。例如，预设的规则可以为在API资源包中设置方法分类集合的埋点信息、方法分类集合中的方法的埋点信息、以及方法中的参数信息的埋点信息。进一步地，具体实现时，可以参考上述图3所示实施例的记载，在API资源包中，在方法分类集合的位置处增加注解标记@APIService，以对方法分类集合做标记；在方法的位置处增加注解标记@APIMethod，以对方法做标记；在参数的属性字段的位置处增加注解标记@APIParam，以对参数的属性字段做标记，等等。通过采用上述方式设置的埋点信息，可以清楚标识方法分类集合、方法以及参数的属性信息，可以进一步提高文档生成时获取相应信息的准确性和效率，进而可以进一步提高文档生成的准确性和效率。

本实施例的API资源包的处理方法与上述图3所示实施例的区别在于：上述图3所实施例在接口文档生成装置侧描述本申请的技术方案；而本实施例可以认为在API资源包的处理装置侧描述本申请的技术方案，其实现原理也可以参考上述图3所示实施例的记载，在此不再赘述。

本实施例的API资源包的处理方法，通过采用上述方法，可以在API资源包中设置埋点信息；并向仓库上传设置了埋点信息的API资源包，以供接口文档生成装置下载API资源包；基于设置的埋点信息对API资源包进行解析，获取接口文档的元信息；并基于接口文档的元信息，生成接口文档，因此，本实施例的技术方案，可以辅助接口文档的生成，提高接口文档的生成效率。

图6是根据本申请第四实施例的示意图；如图6所示，本实施例提供一种接口文档的生成装置600，包括：

下载模块601，用于从仓库中下载应用程序接口资源包；

解析模块602，用于对应用程序接口资源包进行解析，获取接口文档的元信息；

生成模块603，用于基于接口文档的元信息，生成接口文档。

本实施例的接口文档的生成装置600，通过采用上述模块实现接口文档的生成的实现原理以及技术效果，与上述相关方法实施例的实现相同，详细可以参考上述相关方法实施例的记载，在此不再赘述。

图7是根据本申请第五实施例的示意图；如图7所示，本实施例的接口文档的生成装置600，在上述图6所示实施例的技术方案的基础上，进一步更加详细地介绍本申请的技术方案。

如图7所示，本实施例的接口文档的生成装置600中，解析模块602，包括：

第一解析单元6021，用于对应用程序接口资源包进行解析，获取方法分类集合的信息；

第二解析单元6022，用于对应用程序接口资源包进行解析，获取方法分类集合中的方法的信息；

第三解析单元6023，用于对应用程序接口资源包进行解析，获取方法中的参数信息。

进一步可选地，其中：

第一解析单元6021，用于基于预设的方法分类集合的埋点信息，对应用程序接口资源包进行解析，获取方法分类集合的信息；

第二解析单元6022，用于基于预设的方法的埋点信息，对应用程序接口资源包进行解析，获取方法分类集合中的方法的信息；

第三解析单元6023，用于：

对应用程序接口资源包进行解析，获取方法中的请求类型和返回类型的信息；

将请求类型的信息和返回类型的信息，分别作为实体进行进一步解析，并基于预设的参数的属性的埋点信息，获取方法中的请求类型和返回类型中的参数的属性信息以及属性信息中包括的参数的属性信息。

本实施例的接口文档的生成装置600，通过采用上述模块实现接口文档的生成的实现原理以及技术效果，与上述相关方法实施例的实现相同，详细可以参考上述相关方法实施例的记载，在此不再赘述。

图8是根据本申请第六实施例的示意图；如图8所示，本实施例提供一种应用程序接口资源包的处理装置800，包括：

获取模块801，用于获取开发的应用程序接口资源包；

设置模块802，用于在应用程序接口资源包中设置埋点信息；

上传模块803，用于向仓库上传设置了埋点信息的应用程序接口资源包，以供接口文档生成装置下载应用程序接口资源包；基于设置的埋点信息对应用程序接口资源包进行解析，获取接口文档的元信息；并基于接口文档的元信息，生成接口文档。

本实施例的应用程序接口资源包的处理装置800，通过采用上述模块实现应用程序接口资源包的处理的实现原理以及技术效果，与上述相关方法实施例的实现相同，详细可以参考上述相关方法实施例的记载，在此不再赘述。

进一步可选地，上述实施例中的设置模块802，用于在应用程序接口资源包中设置方法分类集合的埋点信息、方法分类集合中的方法的埋点信息、以及方法中的参数的属性的埋点信息。

根据本申请的实施例，本申请还提供了一种电子设备和一种可读存储介质。

如图9所示，是本申请实施例的实现接口文档的生成方法或者应用程序接口资源包的处理方法的电子设备的框图。电子设备旨在表示各种形式的数字计算机，诸如，膝上型计算机、台式计算机、工作台、个人数字助理、服务器、刀片式服务器、大型计算机、和其它适合的计算机。电子设备还可以表示各种形式的移动装置，诸如，个人数字处理、蜂窝电话、智能电话、可穿戴设备和其它类似的计算装置。本文所示的部件、它们的连接和关系、以及它们的功能仅仅作为示例，并且不意在限制本文中描述的和/或者要求的本申请的实现。

如图9所示，该电子设备包括：一个或多个处理器901、存储器902，以及用于连接各部件的接口，包括高速接口和低速接口。各个部件利用不同的总线互相连接，并且可以被安装在公共主板上或者根据需要以其它方式安装。处理器可以对在电子设备内执行的指令进行处理，包括存储在存储器中或者存储器上以在外部输入/输出装置(诸如，耦合至接口的显示设备)上显示GUI的图形信息的指令。在其它实施方式中，若需要，可以将多个处理器和/或多条总线与多个存储器和多个存储器一起使用。同样，可以连接多个电子设备，各个设备提供部分必要的操作(例如，作为服务器阵列、一组刀片式服务器、或者多处理器系统)。图9中以一个处理器901为例。

存储器902即为本申请所提供的非瞬时计算机可读存储介质。其中，所述存储器存储有可由至少一个处理器执行的指令，以使所述至少一个处理器执行本申请所提供的接口文档的生成方法或者应用程序接口资源包的处理方法。本申请的非瞬时计算机可读存储介质存储计算机指令，该计算机指令用于使计算机执行本申请所提供的接口文档的生成方法或者应用程序接口资源包的处理方法。

存储器902作为一种非瞬时计算机可读存储介质，可用于存储非瞬时软件程序、非瞬时计算机可执行程序以及模块，如本申请实施例中的接口文档的生成方法对应的程序指令/模块(例如，附图6和附图7所示的相关模块)，或者如本申请实施例中的应用程序接口资源包的处理方法对应的程序指令/模块(例如，附图8所示的相关模块)。处理器901通过运行存储在存储器902中的非瞬时软件程序、指令以及模块，从而执行服务器的各种功能应用以及数据处理，即实现上述方法实施例中的接口文档的生成方法或者应用程序接口资源包的处理方法。

存储器902可以包括存储程序区和存储数据区，其中，存储程序区可存储操作系统、至少一个功能所需要的应用程序；存储数据区可存储根据实现接口文档的生成方法或者应用程序接口资源包的处理方法的电子设备的使用所创建的数据等。此外，存储器902可以包括高速随机存取存储器，还可以包括非瞬时存储器，例如至少一个磁盘存储器件、闪存器件、或其他非瞬时固态存储器件。在一些实施例中，存储器902可选包括相对于处理器901远程设置的存储器，这些远程存储器可以通过网络连接至实现接口文档的生成方法或者应用程序接口资源包的处理方法的电子设备。上述网络的实例包括但不限于互联网、企业内部网、局域网、移动通信网及其组合。

实现接口文档的生成方法或者应用程序接口资源包的处理方法的电子设备还可以包括：输入装置903和输出装置904。处理器901、存储器902、输入装置903和输出装置904可以通过总线或者其他方式连接，图9中以通过总线连接为例。

输入装置903可接收输入的数字或字符信息，以及产生与实现接口文档的生成方法或者应用程序接口资源包的处理方法的电子设备的用户设置以及功能控制有关的键信号输入，例如触摸屏、小键盘、鼠标、轨迹板、触摸板、指示杆、一个或者多个鼠标按钮、轨迹球、操纵杆等输入装置。输出装置904可以包括显示设备、辅助照明装置(例如，LED)和触觉反馈装置(例如，振动电机)等。该显示设备可以包括但不限于，液晶显示器(LCD)、发光二极管(LED)显示器和等离子体显示器。在一些实施方式中，显示设备可以是触摸屏。

此处描述的系统和技术的各种实施方式可以在数字电子电路系统、集成电路系统、专用ASIC(专用集成电路)、计算机硬件、固件、软件、和/或它们的组合中实现。这些各种实施方式可以包括：实施在一个或者多个计算机程序中，该一个或者多个计算机程序可在包括至少一个可编程处理器的可编程系统上执行和/或解释，该可编程处理器可以是专用或者通用可编程处理器，可以从存储系统、至少一个输入装置、和至少一个输出装置接收数据和指令，并且将数据和指令传输至该存储系统、该至少一个输入装置、和该至少一个输出装置。

这些计算程序(也称作程序、软件、软件应用、或者代码)包括可编程处理器的机器指令，并且可以利用高级过程和/或面向对象的编程语言、和/或汇编/机器语言来实施这些计算程序。如本文使用的，术语“机器可读介质”和“计算机可读介质”指的是用于将机器指令和/或数据提供给可编程处理器的任何计算机程序产品、设备、和/或装置(例如，磁盘、光盘、存储器、可编程逻辑装置(PLD))，包括，接收作为机器可读信号的机器指令的机器可读介质。术语“机器可读信号”指的是用于将机器指令和/或数据提供给可编程处理器的任何信号。

为了提供与用户的交互，可以在计算机上实施此处描述的系统和技术，该计算机具有：用于向用户显示信息的显示装置(例如，CRT(阴极射线管)或者LCD(液晶显示器)监视器)；以及键盘和指向装置(例如，鼠标或者轨迹球)，用户可以通过该键盘和该指向装置来将输入提供给计算机。其它种类的装置还可以用于提供与用户的交互；例如，提供给用户的反馈可以是任何形式的传感反馈(例如，视觉反馈、听觉反馈、或者触觉反馈)；并且可以用任何形式(包括声输入、语音输入或者、触觉输入)来接收来自用户的输入。

可以将此处描述的系统和技术实施在包括后台部件的计算系统(例如，作为数据服务器)、或者包括中间件部件的计算系统(例如，应用服务器)、或者包括前端部件的计算系统(例如，具有图形用户界面或者网络浏览器的用户计算机，用户可以通过该图形用户界面或者该网络浏览器来与此处描述的系统和技术的实施方式交互)、或者包括这种后台部件、中间件部件、或者前端部件的任何组合的计算系统中。可以通过任何形式或者介质的数字数据通信(例如，通信网络)来将系统的部件相互连接。通信网络的示例包括：局域网(LAN)、广域网(WAN)、互联网和区块链网络。

计算机系统可以包括客户端和服务器。客户端和服务器一般远离彼此并且通常通过通信网络进行交互。通过在相应的计算机上运行并且彼此具有客户端-服务器关系的计算机程序来产生客户端和服务器的关系。

根据本申请实施例的技术方案，通过从仓库中下载API资源包；对应用程序接口资源包进行解析，获取接口文档的元信息；基于接口文档的元信息，生成接口文档，与现有技术相比，不用开发人员手动编写接口文档，可以自动地实现接口文档的生成，能够有效地保证接口文档生成的准确性。而且避免后端开发人员手动编写接口文档，能够有效地节省人力，缩短接口文档的生成时间，提高接口文档的生成效率。

根据本申请实施例的技术方案，可以基于预设的埋点信息，解析API资源包，获取其中的方法分类集合、方法分类集合中的方法以及方法中的参数信息，并最终基于解析获取到的信息生成接口文档。本实施例的技术方案，基于预设的埋点信息，对API资源包进行解析，不仅可以进一步提高生成的接口文档的准确性，同时还能够进一步提高接口文档的生成效率。

根据本申请实施例的技术方案，可以在API资源包中设置埋点信息；并向仓库上传设置了埋点信息的API资源包，以供接口文档生成装置下载API资源包；基于设置的埋点信息对API资源包进行解析，获取接口文档的元信息；并基于接口文档的元信息，生成接口文档，因此，本实施例的技术方案，可以辅助接口文档的生成，提高接口文档的生成效率。

应该理解，可以使用上面所示的各种形式的流程，重新排序、增加或删除步骤。例如，本发申请中记载的各步骤可以并行地执行也可以顺序地执行也可以不同的次序执行，只要能够实现本申请公开的技术方案所期望的结果，本文在此不进行限制。

上述具体实施方式，并不构成对本申请保护范围的限制。本领域技术人员应该明白的是，根据设计要求和其他因素，可以进行各种修改、组合、子组合和替代。任何在本申请的精神和原则之内所作的修改、等同替换和改进等，均应包含在本申请保护范围之内。

Claims (12)

1.一种接口文档的生成方法，其中，所述方法包括：

从仓库中下载应用程序接口资源包；

对所述应用程序接口资源包进行解析，获取接口文档的元信息；

基于所述接口文档的元信息，生成所述接口文档。

2.根据权利要求1所述的方法，其中，对所述应用程序接口资源包进行解析，获取接口文档的元信息，包括：

对所述应用程序接口资源包进行解析，获取方法分类集合的信息；

对所述应用程序接口资源包进行解析，获取所述方法分类集合中的方法的信息；

对所述应用程序接口资源包进行解析，获取所述方法中的参数信息。

3.根据权利要求2所述的方法，其中，对所述应用程序接口资源包进行解析，获取方法分类集的信息，包括：

基于预设的方法分类集合的埋点信息，对所述应用程序接口资源包进行解析，获取所述方法分类集合的信息；

对所述应用程序接口资源包进行解析，获取所述方法分类集合中的方法的信息，包括：

基于预设的方法的埋点信息，对所述应用程序接口资源包进行解析，获取所述方法分类集合中的方法的信息；

对所述应用程序接口资源包进行解析，获取所述方法中的参数信息，包括：

对所述应用程序接口资源包进行解析，获取所述方法中的请求类型和返回类型的信息；

将所述请求类型的信息和所述返回类型的信息，分别作为实体进行进一步解析，并基于预设的参数的属性的埋点信息，获取所述方法中的请求类型和返回类型中的参数的属性信息以及所述属性信息中包括的参数的属性信息。

4.一种应用程序接口资源包的处理方法，其中，所述方法包括：

获取开发的应用程序接口资源包；

在所述应用程序接口资源包中设置埋点信息；

向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

5.根据权利要求4所述的方法，其中，在所述应用程序接口资源包中设置埋点信息，包括：

在所述应用程序接口资源包中设置方法分类集合的埋点信息、所述方法分类集合中的方法的埋点信息、以及所述方法中的参数的属性的埋点信息。

6.一种接口文档的生成装置，其中，所述装置包括：

下载模块，用于从仓库中下载应用程序接口资源包；

解析模块，用于对所述应用程序接口资源包进行解析，获取接口文档的元信息；

生成模块，用于基于所述接口文档的元信息，生成所述接口文档。

7.根据权利要求6所述的装置，其中，所述解析模块，包括：

第一解析单元，用于对所述应用程序接口资源包进行解析，获取方法分类集合的信息；

第二解析单元，用于对所述应用程序接口资源包进行解析，获取所述方法分类集合中的方法的信息；

第三解析单元，用于对所述应用程序接口资源包进行解析，获取所述方法中的参数信息。

8.根据权利要求7所述的装置，其中：

所述第一解析单元，用于基于预设的方法分类集合的埋点信息，对所述应用程序接口资源包进行解析，获取所述方法分类集合的信息；

所述第二解析单元，用于基于预设的方法的埋点信息，对所述应用程序接口资源包进行解析，获取所述方法分类集合中的方法的信息；

所述第三解析单元，用于：

对所述应用程序接口资源包进行解析，获取所述方法中的请求类型和返回类型的信息；

将所述请求类型的信息和所述返回类型的信息，分别作为实体进行进一步解析，并基于预设的参数的属性的埋点信息，获取所述方法中的请求类型和返回类型中的参数的属性信息以及所述属性信息中包括的参数的属性信息。

9.一种应用程序接口资源包的处理装置，其中，所述装置包括：

获取模块，用于获取开发的应用程序接口资源包；

设置模块，用于在所述应用程序接口资源包中设置埋点信息；

上传模块，用于向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

10.根据权利要求9所述的装置，其中，所述设置模块，用于在所述应用程序接口资源包中设置方法分类集合的埋点信息、所述方法分类集合中的方法的埋点信息、以及所述方法中的参数的属性的埋点信息。

11.一种电子设备，其特征在于，包括：

至少一个处理器；以及

与所述至少一个处理器通信连接的存储器；其中，

所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行权利要求1-3、或者4-5中任一项所述的方法。

12.一种存储有计算机指令的非瞬时计算机可读存储介质，其特征在于，所述计算机指令用于使所述计算机执行权利要求1-3、或者4-5中任一项所述的方法。

Images