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

Abstract

本公开是关于一种接口文档生成方法、接口文档生成装置、存储介质以及电子设备，涉及计算机技术领域。该方法包括：根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。本公开提高了接口文档的生成效率。

Description

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

技术领域

本公开实施例涉及计算机技术领域，具体而言，涉及一种接口文档生成方法、接口文档生成装置、存储介质以及电子设备。

背景技术

在前后端分离的项目开发过程中，为了便于前后端工程师的沟通交流以及后期维护人员的查看、维护，需要由前后端工程师共同定义接口，并编写接口文档。

目前，接口文档的编写已经由原来的手工编写发展到通过编程来实现遵循openAPI 2.0(open Application Programming Interface，开放应用编程接口)规范的接口文档，但是，仍然存在以下问题：一方面，当应用程序中包括不同应用进程时，相关人员需要记录不同应用服务对应的接口文档的地址，不能对各应用进程对应的接口文档进行统一操作处理；另一方面，应用上线时，需要维护人员对应用进程对应的配置信息进行更改，才能保证应用的正常上线以及接口文档的生成，导致接口文档生成效率较低。

因此，需要提供一种新的接口文档生成方法。

需要说明的是，在上述背景技术部分发明的信息仅用于加强对本发明的背景的理解，因此可以包括不构成对本领域普通技术人员已知的现有技术的信息。

发明内容

本发明的目的在于提供一种接口文档生成方法、接口文档生成装置、存储介质以及电子设备，进而至少在一定程度上克服由于相关技术的限制和缺陷而导致的接口文档生成效率低的问题。

根据本公开的一个方面，提供一种接口文档生成方法，包括：

根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

在本公开的一种示例性实施例中，所述接口文档生成方法还包括：

从预设的配置中心获取所述当前状态为运行状态的第二目标容器，以及所述第二目标容器中所运行的应用进程的第二配置信息；

根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，得到与所述第二配置信息对应的接口文档。

在本公开的一种示例性实施例中，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息，包括：

获取所述应用进程的命名空间、名称以及所述应用进程所在的容器集合的名称；

根据所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成与所述应用进程对应的第一配置信息。

在本公开的一种示例性实施例中，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，包括：

根据所述第一配置信息中包括的所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成所述第一请求地址；

根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档。

在本公开的一种示例性实施例中，根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档，包括：

在所述应用进程的项目对象模型中引入所述文档生成工具的依赖；

基于所述依赖，读取所述应用进程所包括的接口数据，利用所述接口数据生成与所述应用进程对应的接口文档。。

在本公开的一种示例性实施例中，通过所述文档生成工具，生成与所述应用进程对应的接口文档，所述接口文档生成方法还包括：

在所述应用进程的框架配置文件中引入文档增强注解；

通过设置文档增强注解对应的属性，完成对所述接口文档的增强。

在本公开的一种示例性实施例中，根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，包括：

遍历所述文档生成工具中包括的运行状态的目标容器的第三配置信息，判断所述第三配置信息与所述第二配置信息是否相同；

当所述第三配置信息与所述第二配置信息不同时，将所述第三配置信息修改为所述第二配置信息中所包括的配置信息，并根据修改后的第三配置信息生成所述文档生成工具可识别的第二请求地址；

当所述第三配置信息与所述第二配置信息相同时，将所述第三配置信息转换成所述文档生成工具可识别的第二请求地址。

根据本公开的一个方面，提供一种接口文档生成装置，包括：

目标容器获取模块，用于根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

第一配置信息生成模块，用于获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

接口文档生成模块，用于根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

根据本公开的一个方面，提供一种存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现上述任意一项所述的接口文档生成方法。

根据本公开的一个方面，提供一种电子设备，包括：

处理器；以及

存储器，用于存储所述处理器的可执行指令；

其中，所述处理器配置为经由执行所述可执行指令来执行上述任意一项所述的接口文档生成方法。

本公开实施例提供的一种接口文档生成方法，一方面，根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，由于根据第一配置信息生成第一请求地址，利用该第一请求地址，通过文档生成工具生成与应用进程对应的接口文档，使得可以对各应用进程的接口文档进行统一管理，解决了现有技术中需要相关技术人员需要记录不同应用服务对应的接口文档的地址，才可以对接口文档进行统一操作处理的问题，提高了接口文档的处理效率；另一方面，当应用服务上线时，即获取到当前状态为运行状态的目标容器之后，可以根据该目标容器中运行的应用进程的第一请求地址自动生成对应的接口文档，不需要维护人员对应用服务对应的配置信息进行更改，提高了接口文档生成的效率。

应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本发明。

附图说明

此处的附图被并入说明书中并构成本说明书的一部分，示出了符合本发明的实施例，并与说明书一起用于解释本发明的原理。显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1示意性示出根据本发明示例实施例的一种接口文档生成方法的流程图。

图2示意性示出根据本发明示例实施例的一种接口文档生成系统的框图。

图3示意性示出根据本发明示例实施例的一种已经上线的应用服务的接口文档生成方法的流程图。

图4示意性示出根据本发明示例实施例的一种根据第二配置信息生成第二请求地址的方法流程图。

图5示意性示出根据本发明示例实施例的一种根据应用进程的属性信息生成与应用进程对应的第一配置信息的方法流程图。

图6示意性示出根据本发明示例实施例的一种文档生成工具根据请求地址生成接口文档的方法流程图。

图7示意性示出根据本发明示例实施例的一种对接口文档开启增强功能的方法流程图。

图8示意性输出根据本发明示例实施例的一种接口文档生成方法的流程图。

图9示意性示出根据本发明示例实施例的一种接口文档生成装置的框图。

图10示意性示出根据本发明示例实施例的一种用于实现上述接口文档生成方法的电子设备。

具体实施方式

现在将参考附图更全面地描述示例实施方式。然而，示例实施方式能够以多种形式实施，且不应被理解为限于在此阐述的范例；相反，提供这些实施方式使得本发明将更加全面和完整，并将示例实施方式的构思全面地传达给本领域的技术人员。所描述的特征、结构或特性可以以任何合适的方式结合在一个或更多实施方式中。在下面的描述中，提供许多具体细节从而给出对本发明的实施方式的充分理解。然而，本领域技术人员将意识到，可以实践本发明的技术方案而省略所述特定细节中的一个或更多，或者可以采用其它的方法、组元、装置、步骤等。在其它情况下，不详细示出或描述公知技术方案以避免喧宾夺主而使得本发明的各方面变得模糊。

此外，附图仅为本发明的示意性图解，并非一定是按比例绘制。图中相同的附图标记表示相同或类似的部分，因而将省略对它们的重复描述。附图中所示的一些方框图是功能实体，不一定必须与物理或逻辑上独立的实体相对应。可以采用软件形式来实现这些功能实体，或在一个或多个硬件模块或集成电路中实现这些功能实体，或在不同网络和/或处理器装置和/或微控制器装置中实现这些功能实体。

目前软件研发，后端设计文档的编写已经成为研发人员不可或缺的一份工作，而相关接口设计文档的编写，由一开始的手工编写，到通过编程来实现遵循OpenAPI 2.0规范的接口文档，已经在一定程度上解放了研发人员的部分文档撰写工作。

在目前的大部分应用软件中，均可通过Swagger2(Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化风格的web服务，其中，Swagger2支持OpenAPI 2.0开发规范)来实现应用软件中包括的各应用服务的文档定义，但是，不能对不同应用服务对应的接口文档进行统一管理；在部分的应用服务中需要提供离线的接口文档，当前的Swagger-UI(针对Swagger2框架提供的文档接口，用于前端UI展示及操作)不支持离线文档的导出；当应用服务的配置文件发生变化时，不能实现应用服务的热发布；当应用服务上线时，需要运维人员对应用服务的配置进行变更，才能保证应用服务的正常上线以及接口文档的生成。

基于上述一个或者多个问题，本示例实施方式首先提供了一种接口文档生成方法，该方法可以运行于服务器、服务器集群或云服务器等，当然，本领域技术人员也可以根据需求在其他平台运行本发明的方法，本示例实施例对此不做具体限定。参考图1所示，该接口文档生成方法可以包括以下步骤：

步骤S110.根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

步骤S120.获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

步骤S130.根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

上述接口文档生成方法，一方面，根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，由于根据第一配置信息生成第一请求地址，利用该第一请求地址，通过文档生成工具生成与应用进程对应的接口文档，使得可以对各应用进程的接口文档进行统一管理，解决了现有技术中需要相关技术人员需要记录不同应用服务对应的接口文档的地址，才可以对接口文档进行统一操作处理的问题，提高了接口文档的处理效率；另一方面，当应用服务上线时，即获取到当前状态为运行状态的目标容器之后，可以根据该目标容器中运行的应用进程的第一请求地址自动生成对应的接口文档，不需要维护人员对应用服务对应的配置信息进行更改，提高了接口文档生成的效率。

以下，对本公开示例实施例的接口文档生成方法中涉及的各步骤进行详细的解释以及说明。

首先，对本公开示例实施例的应用场景以及发明目的进行解释以及说明。

具体的，本公开示例实施例可以用于前后端分离的应用系统中，主要用于自动识别应用系统中应用服务的上下线，当应用服务上线时可以根据应用服务的属性信息自动生成对应接口文档，此外，对已经上线的应用服务的接口文档进行统一管理。

本公开示例实施例以运行状态的目标容器为基础，对此进行分析得到目标容器中运行的应用进程的配置信息，根据配置信息得到应用进程的请求地址，基于该请求地址自动生成应用进程的接口文档，提高了接口文档的生成效率。具体理由如下：一方面，通过文档生成工具生成应用进程对应的文档，对于已上线的应用服务可以生成格式统一的接口文档，实现对接口文档的统一管理；另一方面，当应用服务上线时，根据新上线的应用服务的请求地址直接生成接口文档，不需要相关人员对应用服务的配置文件进行修改，提高了应用服务的接口文档的生成效率。

其次，对本公开示例实施例中涉及的接口文档生成系统进行解释以及说明。参考图2所示，该接口文档生成系统可以包括：配置中心210以及文档聚合中心220。其中，配置中心采用Apollo(阿波罗)，可以集中化管理应用不同环境、不同集群的配置，配置修改后可以实时推送到应用端，用于对已经上线的应用进程的配置文件进行统一管理，当应用进程的配置文件修改后，直接将修改后的配置文件发送到文档聚合中心220，以根据最新的配置文件生成应用进程的接口文档；文档聚合中心220，与配置中心210网络连接，可以包括容器编排工具221以及文档生成工具222，其中，容器编排工具为kubernetes(简称k8s，用于管理云平台中多个主机上的容器化应用)用于对应用服务进行监控，自动识别应用服务的上线以及下线，当应用服务上线时，根据应用服务对应的应用进程的属性信息生成配置信息，再将配置信息转换成请求地址，并将该请求地址发送至文档生成工具222；文档生成工具222，与容器编排工具网络连接，为knife4jAggregation(微服务聚合中间件)，用于接收容器编排工具221发送的请求地址，并根据该请求地址生成应用进程的接口文档，使用者可以在该应用进程的展示页面对该接口文档进行查看以及离线下载。

以下，将结合图2对步骤S110-步骤S130进行解释以及说明。

在步骤S110中，根据容器的运行状态确定至少一个第一目标容器，其中，所述目标容器的当前状态为运行状态。

在本示例实施中，在容器编排工具k8s中，一个pod(由一个或者一个以上的容器做成的，在k8s中是最小的可被调度的原子单位)代表集群中运行的一个进程，pod中封装着容器，因此，容器的运行状态可以为pod的生命周期，pod的生命周期可以包括：挂起、运行、成功、时报以及未知，其中，挂起表示该pod已被创建，但是未被调度完成，或者仍然处于仓库下载镜像的过程中；运行表示该pod已被调度到某个节点之上，并且所有的容器已经被创建完成；成功表示pod中所有容器都被成功终止，并且不会再重启；失败表示pod中的所有容器都已经终止了，并且至少有一个容器是因为失败终止，即，容器以非0状态退出或者被系统终止；未知表示因为某些原因无法取得pod的状态，通常是因为与pod所在主机通信失败。当应用服务上线时，与该应用服务对应的目标容器的状态为运行状态，因此，为了自动生成新上线的应用服务的接口文档，首先需要获取当前状态为运行状态的目标容器。

对于已经上线的应用服务可以通过配置中心获取对应的配置信息，根据配置信息生成请求地址，再通过请求地址生成对应的接口文档，具体的，参考图3所示，对于已经上线的应用服务，接口文档生成方法还可以包括步骤S310以及步骤S320：

在步骤S310中，从预设的配置中心获取所述当前状态为运行状态的第二目标容器，以及所述第二目标容器中所运行的应用进程的第二配置信息；

在步骤S320中，根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，得到与所述第二配置信息对应的接口文档。

以下，将对步骤S310以及步骤S320进行解释以及说明。具体的，首先在配置中心Apollo中获取已经上线且仍然提供服务的应用进程的配置文件，即，获得当前状态为运行状态的第二目标容器，以及第二目标容器中运行的应用进程的配置信息，其中，应用进程的配置信息可以包括：与应用进程对应的应用服务的名称以及OpenAPI接口地址(与应用进程对应的应用服务的地址)；当获得应用进程的配置信息后，可以根据配置信息生成应用服务接口文档的请求地址；文档生成工具knife4jAggregation根据该接口文档的请求地址生成与该应用进程对应的接口文档。

进一步的，参考图4所示，根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，可以包括步骤S410-步骤S430：

在步骤S410中，遍历所述文档生成工具中包括的运行状态的目标容器的第三配置信息，判断所述第三配置信息与所述第二配置信息是否相同；

在步骤S420中，当所述第三配置信息与所述第二配置信息不同时，将所述第三配置信息修改为所述第二配置信息中所包括的配置信息，并根据修改后的第三配置信息生成所述文档生成工具可识别的第二请求地址；

在步骤S430中，当所述第三配置信息与所述第二配置信息相同时，将所述第三配置信息转换成所述文档生成工具可识别的第二请求地址。

以下，将对步骤S410-步骤S430进行解释以及说明。具体的，对于已经上线的应用服务，文档生成工具knife4jAggregation是通过内部的API配置集合来完成接口文档展示的,当从Apollo配置中心获取到运行状态的目标容器的配置文件后，需要对文档生成工具的接口文档配置集合进行遍历，判断运行状态的第二目标容器的配置信息与文档生成工具中包括的该目标容器的配置信息是否相同，当相同时，将文档生成工具中包括的该目标容器的配置信息生成文档生成工具可是别的接口文档请求地址；当配置中心获取的配置信息与文档生成工具中包括的配置信息不同时，对文档生成工具中包括的配置信息进行更行，并根据更新后的配置信息生成接口文档请求地址。

在步骤S120中，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息。

在本示例实施例中，参考图5所示，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息，可以包括步骤S510以及步骤S520：

在步骤S510中，获取所述应用进程的命名空间、名称以及所述应用进程所在的容器集合的名称；

在步骤S520中，根据所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成与所述应用进程对应的第一配置信息。

以下，将对步骤S510以及步骤S520进行解释以及说明。具体的，应用进程的命名空间namespace是指一个作用域，作用域是指通过建立service(服务)访问pod时，如果service的命名空间不指定正确，就无法通过标签关联到pod；应用进程所在的容器集合的名称为该应用该进程所在pod的名称。具体的，首先，通过服务编排工具k8s提供的接口KubernetesJava Client获取应用进程的命名空间、名称以及该应用进程所在容器集合的名称，然后，根据获得的属性信息生成与应用进程对应的第一配置信息。

在步骤S130中，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

其中，第一请求地址为应用服务的接口文档的请求地址，文档生成工具为knife4jAggregation，该文档生成工具提供了knife4j-aggregation-spring-boot-starter组件，该组件是一个基于Spring Boot系统的starter(starter负责配置好与spring整合相关的配置和相关依赖)，提供了以下几种能力：让所有的基于Spring Boot的web体系拥有了轻松聚合OpenAPI的能力，同时兼容OpenAPI2规范以及OpenAPI3规范。通过该文档生成工具生成的接口文档可以通过用户客户端的查询请求进而展示该接口文档。

在本示例实施例中，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，包括：

根据所述第一配置信息中包括的所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成所述第一请求地址；

根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档。

具体的，可以根据应用进程的配置信息生成接口文档请求地址，即，第一请求地址，其中，接口文档请求地址中包括应用进程的命名空间、应用进程的名称以及应用进程所在pod的名称，该第一请求地址可以被文档生成工具识别；得到接口文档的请求地址后，文档生成工具根据请求地址读取应用进程的请求方法、URL(Uniform Resource Locator，统一资源定位符)、请求参数以及返回参数，并根据应用进程的请求方法、URL、请求参数以及返回参数生成接口文档。

进一步的，参考图6所示，文档生成工具根据请求地址生成接口文档，可以包括步骤S610以及步骤S620：

在步骤S610中，在所述应用进程的项目对象模型中引入所述文档生成工具的依赖；

在步骤S620中，基于所述依赖，读取所述应用进程所包括的接口数据，利用所述接口数据生成与所述应用进程对应的接口文档。

以下，将对步骤S620以及步骤S620进行解释以及说明。具体的，项目对象模型(Project Object Model，POM)，为项目中的文件，用XML来表示，名称为pom.xml，用于管理源代码、配置文件、项目的URL以及项目的依赖关系等，在pom.xml文件中引入knife4j的依赖，具体可以为：<artifactId>knife4j-spring-boot-starter</artifactId>；其次，创建Swagger的配置文件，其中，包括注解@EnableSwagger2以及注解@EnableKnife4j，注解@EnableSwagger2是Springfox-swagger框架提供的使用Swagger注解，必须添加；注解@EnableKnife4j是knife4j提供的增强注解，当需要使用增强功能时必须增加该注解，否则可以不用添加；当添加注解@EnableSwagger2后，可以获取应用进程中包括的接口数据，其中，接口数据可以包括：应用进程的请求方法、URL、请求参数以及返回参数；最后，根据接口数据生成接口文档。

再进一步的，参考图7所示，当需要对接口文档开启增强功能时，接口文档生成方法可以包括步骤S710以及步骤S720：

在步骤S710中，在所述应用进程的框架配置文件中引入文档增强注解；

在步骤S720中，通过设置文档增强注解对应的属性，完成对所述接口文档的增强。

以下，将对步骤S710以及步骤S720进行解释以及说明。具体的，应用进程的框架配置文件为Swagger配置文件，文档增强的注解为@EnableKnife4j，文档增强包括请求参数缓存、动态调试参数以及离线文档中的一种或多种，其中，请求参数缓存对应的属性为knife4j.setting.enableRequestCache，默认值为true，动态调试对应的属性为knife4j.setting.enableDynamicParameter，默认值为false，离线文档可以包括导出Markdown(一种轻量级标记语言)和离线HTML(Hyper TextMarkup Language，超文本标记语言)，导出Markdown对应的属性为knife4j.setting.homeCustomLocation。

本公开示例实施例提供的接口文档生成方法以及接口文档生成系统至少具有以下优点：一方面，针对已上线的应用服务，通过获取对应的配置信息，根据配置信息生成接口文档请求地址，文档生成工具通过接口文档请求地址生成统一格式的接口文档，提高了接口文档的生成效率；另一方面，当应用服务上线时，可以根据应用服务的属性信息生成接口文档请求地址，并根据该接口文档请求地址生成接口文档，不需要维护人员对应用服务的配置信息进行更改，提高了接口文档的生成效率。

以下，结合图8对本公开示例实施例的接口文档生成方法进行进一步的解释以及说明。其中，接口文档生成方法可以包括以下步骤：

步骤S810.判断应用服务是否为新上线的服务；

步骤S820.当应用服务为新上线的服务时，获取当前状态为运行状态的目标容器；

步骤S822.获取当前状态为运行状态的目标容器中所运行的应用进程，以及应用进程的属性信息；

步骤S824.根据应用进程的属性信息生成第一配置信息，并根据第一配置信息生成请求地址；

步骤S830.当应用服务为已经上线的服务时，从配置中心中获取当前状态为运行状态的目标容器；

步骤S832.获取目标容器中运行的应用进程的配置信息；

步骤S834.根据目标容器中运行的应用进程的配置信息生成请求地址；

步骤S840.文档生成工具读取请求地址，并根据该请求地址对应的应用进程的接口数据生成接口文档。

本公开示例实施例还提供了一种接口文档生成装置，参考图9所示，该接口文档生成装置可以包括：目标容器获取模块910、第一配置信息生成模块920以及接口文档生成模块930。其中：

目标容器获取模块910，用于根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

第一配置信息生成模块920，用于获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

接口文档生成模块930，用于根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

在本公开的一种示例性实施例中，所述接口文档生成方法还包括：

从预设的配置中心获取所述当前状态为运行状态的第二目标容器，以及所述第二目标容器中所运行的应用进程的第二配置信息；

根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，得到与所述第二配置信息对应的接口文档。

在本公开的一种示例性实施例中，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息，包括：

获取所述应用进程的命名空间、名称以及所述应用进程所在的容器集合的名称；

根据所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成与所述应用进程对应的第一配置信息。

在本公开的一种示例性实施例中，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，包括：

根据所述第一配置信息中包括的所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成所述第一请求地址；

根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档。

在本公开的一种示例性实施例中，根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档，包括：

在所述应用进程的项目对象模型中引入所述文档生成工具的依赖；

基于所述依赖，读取所述应用进程所包括的接口数据，利用所述接口数据生成与所述应用进程对应的接口文档。。

在本公开的一种示例性实施例中，通过所述文档生成工具，生成与所述应用进程对应的接口文档，所述接口文档生成方法还包括：

在所述应用进程的框架配置文件中引入文档增强注解；

通过设置文档增强注解对应的属性，完成对所述接口文档的增强。

在本公开的一种示例性实施例中，根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，包括：

遍历所述文档生成工具中包括的运行状态的目标容器的第三配置信息，判断所述第三配置信息与所述第二配置信息是否相同；

当所述第三配置信息与所述第二配置信息不同时，将所述第三配置信息修改为所述第二配置信息中所包括的配置信息，并根据修改后的第三配置信息生成所述文档生成工具可识别的第二请求地址；

当所述第三配置信息与所述第二配置信息相同时，将所述第三配置信息转换成所述文档生成工具可识别的第二请求地址。

上述接口文档生成装置中各模块的具体细节已经在对应的接口文档生成方法中进行了详细的描述，因此此处不再赘述。

应当注意，尽管在上文详细描述中提及了用于动作执行的设备的若干模块或者单元，但是这种划分并非强制性的。实际上，根据本发明的实施方式，上文描述的两个或更多模块或者单元的特征和功能可以在一个模块或者单元中具体化。反之，上文描述的一个模块或者单元的特征和功能可以进一步划分为由多个模块或者单元来具体化。

此外，尽管在附图中以特定顺序描述了本发明中方法的各个步骤，但是，这并非要求或者暗示必须按照该特定顺序来执行这些步骤，或是必须执行全部所示的步骤才能实现期望的结果。附加的或备选的，可以省略某些步骤，将多个步骤合并为一个步骤执行，以及/或者将一个步骤分解为多个步骤执行等。

在本发明的示例性实施例中，还提供了一种能够实现上述数据转换方法的电子设备。

所属技术领域的技术人员能够理解，本发明的各个方面可以实现为系统、方法或程序产品。因此，本发明的各个方面可以具体实现为以下形式，即：完全的硬件实施方式、完全的软件实施方式(包括固件、微代码等)，或硬件和软件方面结合的实施方式，这里可以统称为“电路”、“模块”或“系统”。

下面参考图10来描述根据本发明的这种实施方式的电子设备1000。图10显示的电子设备1000仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。

如图10所示，电子设备以通用计算设备的形式表现。电子设备的组件可以包括但不限于：上述至少一个处理单元1010、上述至少一个存储单元1020、连接不同系统组件(包括存储单元1020和处理单元1010)的总线1030以及显示单元1040。

其中，所述存储单元存储有程序代码，所述程序代码可以被所述处理单元1010执行，使得所述处理单元1010执行本说明书上述“示例性方法”部分中描述的根据本发明各种示例性实施方式的步骤。例如，所述处理单元1010可以执行如图1中所示的步骤S110：根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；步骤S120：获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；步骤S130：根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

存储单元1020可以包括易失性存储单元形式的可读介质，例如随机存取存储单元(RAM)10201和/或高速缓存存储单元10202，还可以进一步包括只读存储单元(ROM)10203。

存储单元1020还可以包括具有一组(至少一个)程序模块10205的程序/实用工具10204，这样的程序模块10205包括但不限于：操作系统、一个或者多个应用程序、其它程序模块以及程序数据，这些示例中的每一个或某种组合中可能包括网络环境的实现。

总线1030可以为表示几类总线结构中的一种或多种，包括存储单元总线或者存储单元控制器、外围总线、图形加速端口、处理单元或者使用多种总线结构中的任意总线结构的局域总线。

电子设备1000也可以与一个或多个外部设备1100(例如键盘、指向设备、蓝牙设备等)通信，还可与一个或者多个使得用户能与该电子设备1000交互的设备通信，和/或与使得该电子设备1000能与一个或多个其它计算设备进行通信的任何设备(例如路由器、调制解调器等等)通信。这种通信可以通过输入/输出(I/O)接口1050进行。并且，电子设备1000还可以通过网络适配器1060与一个或者多个网络(例如局域网(LAN)，广域网(WAN)和/或公共网络，例如因特网)通信。如图所示，网络适配器1060通过总线1030与电子设备1000的其它模块通信。应当明白，尽管图中未示出，可以结合电子设备1000使用其它硬件和/或软件模块，包括但不限于：微代码、设备驱动器、冗余处理单元、外部磁盘驱动阵列、RAID系统、磁带驱动器以及数据备份存储系统等。

通过以上的实施方式的描述，本领域的技术人员易于理解，这里描述的示例实施方式可以通过软件实现，也可以通过软件结合必要的硬件的方式来实现。因此，根据本发明实施方式的技术方案可以以软件产品的形式体现出来，该软件产品可以存储在一个非易失性存储介质(可以是CD-ROM，U盘，移动硬盘等)中或网络上，包括若干指令以使得一台计算设备(可以是个人计算机、服务器、终端装置、或者网络设备等)执行根据本发明实施方式的方法。

在本发明的示例性实施例中，还提供了一种计算机可读存储介质，其上存储有能够实现本说明书上述方法的程序产品。在一些可能的实施方式中，本发明的各个方面还可以实现为一种程序产品的形式，其包括程序代码，当所述程序产品在终端设备上运行时，所述程序代码用于使所述终端设备执行本说明书上述“示例性方法”部分中描述的根据本发明各种示例性实施方式的步骤。

根据本发明的实施方式的用于实现上述方法的程序产品，其可以采用便携式紧凑盘只读存储器(CD-ROM)并包括程序代码，并可以在终端设备，例如个人电脑上运行。然而，本发明的程序产品不限于此，在本文件中，可读存储介质可以是任何包含或存储程序的有形介质，该程序可以被指令执行系统、装置或者器件使用或者与其结合使用。

所述程序产品可以采用一个或多个可读介质的任意组合。可读介质可以是可读信号介质或者可读存储介质。可读存储介质例如可以为但不限于电、磁、光、电磁、红外线、或半导体的系统、装置或器件，或者任意以上的组合。可读存储介质的更具体的例子(非穷举的列表)包括：具有一个或多个导线的电连接、便携式盘、硬盘、随机存取存储器(RAM)、只读存储器(ROM)、可擦式可编程只读存储器(EPROM或闪存)、光纤、便携式紧凑盘只读存储器(CD-ROM)、光存储器件、磁存储器件、或者上述的任意合适的组合。

计算机可读信号介质可以包括在基带中或者作为载波一部分传播的数据信号，其中承载了可读程序代码。这种传播的数据信号可以采用多种形式，包括但不限于电磁信号、光信号或上述的任意合适的组合。可读信号介质还可以是可读存储介质以外的任何可读介质，该可读介质可以发送、传播或者传输用于由指令执行系统、装置或者器件使用或者与其结合使用的程序。

可读介质上包含的程序代码可以用任何适当的介质传输，包括但不限于无线、有线、光缆、RF等等，或者上述的任意合适的组合。

可以以一种或多种程序设计语言的任意组合来编写用于执行本发明操作的程序代码，所述程序设计语言包括面向对象的程序设计语言—诸如Java、C++等，还包括常规的过程式程序设计语言—诸如“C”语言或类似的程序设计语言。程序代码可以完全地在用户计算设备上执行、部分地在用户设备上执行、作为一个独立的软件包执行、部分在用户计算设备上部分在远程计算设备上执行、或者完全在远程计算设备或服务器上执行。在涉及远程计算设备的情形中，远程计算设备可以通过任意种类的网络，包括局域网(LAN)或广域网(WAN)，连接到用户计算设备，或者，可以连接到外部计算设备(例如利用因特网服务提供商来通过因特网连接)。

此外，上述附图仅是根据本发明示例性实施例的方法所包括的处理的示意性说明，而不是限制目的。易于理解，上述附图所示的处理并不表明或限制这些处理的时间顺序。另外，也易于理解，这些处理可以是例如在多个模块中同步或异步执行的。

本领域技术人员在考虑说明书及实践这里发明的发明后，将容易想到本发明的其他实施例。本申请旨在涵盖本发明的任何变型、用途或者适应性变化，这些变型、用途或者适应性变化遵循本发明的一般性原理并包括本发明未发明的本技术领域中的公知常识或惯用技术手段。说明书和实施例仅被视为示例性的，本发明的真正范围和精神由权利要求指出。

Claims (10)

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

根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

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

从预设的配置中心获取所述当前状态为运行状态的第二目标容器，以及所述第二目标容器中所运行的应用进程的第二配置信息；

根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，得到与所述第二配置信息对应的接口文档。

3.根据权利要求2所述的接口文档生成方法，其特征在于，获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息，包括：

获取所述应用进程的命名空间、名称以及所述应用进程所在的容器集合的名称；

根据所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成与所述应用进程对应的第一配置信息。

4.根据权利要求3所述的接口文档生成方法，其特征在于，根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档，包括：

根据所述第一配置信息中包括的所述命名空间、名称以及所述应用进程所在的容器集合的名称，生成所述第一请求地址；

根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档。

5.根据权利要求4所述的接口文档生成方法，其特征在于，根据所述第一请求地址，通过所述文档生成工具，生成与所述应用进程对应的接口文档，包括：

在所述应用进程的项目对象模型中引入所述文档生成工具的依赖；

基于所述依赖，读取所述应用进程所包括的接口数据，利用所述接口数据生成与所述应用进程对应的接口文档。

6.根据权利要求要求5所述的接口文档生成方法，其特征在于，通过所述文档生成工具，生成与所述应用进程对应的接口文档，所述接口文档生成方法还包括：

在所述应用进程的框架配置文件中引入文档增强注解；

通过设置文档增强注解对应的属性，完成对所述接口文档的增强。

7.根据权利要求2所述的接口文档生成方法，其特征在于，根据所述第二配置信息生成第二请求地址，通过所述文档生成工具读取所述第二请求地址，包括：

遍历所述文档生成工具中包括的运行状态的目标容器的第三配置信息，判断所述第三配置信息与所述第二配置信息是否相同；

当所述第三配置信息与所述第二配置信息不同时，将所述第三配置信息修改为所述第二配置信息中所包括的配置信息，并根据修改后的第三配置信息生成所述文档生成工具可识别的第二请求地址；

当所述第三配置信息与所述第二配置信息相同时，将所述第三配置信息转换成所述文档生成工具可识别的第二请求地址。

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

目标容器获取模块，用于根据容器的运行状态确定至少一个第一目标容器，其中所述第一目标容器的当前状态为运行状态；

第一配置信息生成模块，用于获取所述第一目标容器中所运行的应用进程，以及所述应用进程的属性信息，并根据所述属性信息生成与所述应用进程对应的第一配置信息；

接口文档生成模块，用于根据所述第一配置信息生成第一请求地址，并通过文档生成工具读取所述第一请求地址，得到与所述应用进程对应的接口文档。

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

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

处理器；以及

存储器，用于存储所述处理器的可执行指令；

其中，所述处理器配置为经由执行所述可执行指令来执行权利要求1-7任一项所述的接口文档生成方法。

Images