CN116432624A

CN116432624A - 一种微服务api文档生成方法、装置、设备、存储介质

Info

Publication number: CN116432624A
Application number: CN202310438612.8A
Authority: CN
Inventors: 周鑫
Original assignee: Shanghai Weimeng Enterprise Development Co ltd
Current assignee: Shanghai Weimeng Enterprise Development Co ltd
Priority date: 2023-04-21
Filing date: 2023-04-21
Publication date: 2023-07-14

Abstract

本申请公开了一种微服务API文档生成方法、装置、设备、存储介质，涉及计算机技术领域，包括：基于业务开发请求定义相应的API接口协议并开发API代码；将API代码提交至预设代码库中，触发API文档生成指令；执述API文档生成指令，以便基于API接口协议中的标准API注释以及对应的API代码生成对应的API文档。通过支持开发通过标准化的API代码，当API代码提交时，直接触发API文档生成指令。通过解析服务，生成对应的API文档的功能，通过自动触发API文档生成指令的方式，使自动化更新生成对应API代码的API文档，并保持API代码和API文档的数据一致性，对API代码零侵入。

Description

一种微服务API文档生成方法、装置、设备、存储介质

技术领域

本发明涉及计算机技术领域，特别涉及一种微服务API文档生成方法、装置、设备、存储介质。

背景技术

当前，互联网的整个系统中，大概率拆分为多个单独的微服务，那多个微服务之间的交互，就需要明确API(Application Programming Interface，应用程序编程接口)的对接文档来说明，并且未来API代码本身有任何的协议变化，例如，协议的增删改等，也需要第一时间及时的同步到API文档中，以便保持API代码和API文档的数据一致性。常见的解决方案，有如下示例：根据API代码，纯手工方式编写对应的API文档，可能是单独的word文档等，并且未来每次接口协议的任何变更，都需要手工的保证两边的数据一致性。根据API代码所在的应用微服务，在应用的客户端测接入类似Swagger(基于客户端模式端文档在线自动生成的工具)插件，未来每次接口协议的变更，手工的触发后续动作：打包代码，构建镜像，发布应用等过程，在应用的客户端测发布完成后可以直接访问对应的API文档。根据API代码，在统一的服务端Yapi(基于服务器端模式端API文档管理平台)管理和维护平台，API文档的录入，具体可以支持纯手工方式录入，也支持半自动方式：先把swagger工具插件生产的API文档导出，再一键导入当前管理平台。这些常规的解决方案，可以一定程度完成当前需求，但还是存在以下缺陷，纯手工方式带来额外的开发人力工作量，特别是API接口数量比较多的时候，当接口数量达到几百，甚至上千的规模时，它的初次0到1的手工维护成本和后续因变更后保持两边数据一致性的维护成本，都比较高，而且还经常容易造成两边数据不一致，也即API代码和API文档不一致，带来其他的功能问题或者服务稳定性的问题等。接入Swagger插件方式可能满足功能需求，但插件本身的使用方式，是一种侵入式的接入成本+需要使用显示方式的新增额外的swagger的注解的维护成本，并且注解还带来对API代码或者应用本身的影响的评估，另外生成API文档还是单独需要手工的触发后才能看到API文档。使用Yapi服务端平台方式需要手工方式或者半自动方式把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接口协议中的标准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文档生成插件的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文档。可见，通过支持开发通过标准化的API代码，然后当API代码提交时，直接触发API文档生成指令。然后基于内置的标准API注释和对应的API代码直接通过解析服务，并生成对应的API文档的功能，通过自动触发API文档生成指令的方式，使自动化更新生成对应API代码的API文档，并一直保持API代码和API文档的数据一致性，并且对API代码零侵入。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。

图1为本申请公开的一种微服务API文档生成方法流程图；

图2为本申请公开的一种业务开发视角API文档闭环生成过程流程图；

图3为本申请公开的一种具体的微服务API文档生成方法流程图；

图4为本申请公开的一种解析Java源文件里API代码上下文生成API文档的服务过程流程图；

图5为本申请公开的一种微服务API文档生成装置结构示意图；

图6为本申请公开的一种电子设备结构图。

具体实施方式

下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

当前，互联网的整个系统中，大概率拆分为多个单独的微服务，那多个微服务之间的交互，就需要明确API的对接文档来说明，并且未来API代码本身有任何的协议变化，例如，协议的增删改等，也需要第一时间及时的同步到API文档中，以便保持API代码和API文档的数据一致性。常见的解决方案，有如下示例：根据API代码，纯手工方式编写对应的API文档，可能是单独的word文档等，并且未来每次接口协议的任何变更，都需要手工的保证两边的数据一致性。根据API代码所在的应用微服务，在应用的客户端测接入类似Swagger插件，未来每次接口协议的变更，手工的触发后续动作：打包代码，构建镜像，发布应用等过程，在应用的客户端测发布完成后可以直接访问对应的API文档。根据API代码，在统一的服务端Yapi管理和维护平台，API文档的录入，具体可以支持纯手工方式录入，也支持半自动方式：先把swagger工具插件生产的API文档导出，再一键导入当前管理平台。这些常规的解决方案，可以一定程度完成当前需求，但还是存在以下缺陷，纯手工方式带来额外的开发人力工作量，特别是API接口数量比较多的时候，当接口数量达到几百，甚至上千的规模时，它的初次0到1的手工维护成本和后续因变更后保持两边数据一致性的维护成本，都比较高，而且还经常容易造成两边数据不一致，也即API代码和API文档不一致，带来其他的功能问题或者服务稳定性的问题等。接入Swagger插件方式可能满足功能需求，但插件本身的使用方式，是一种侵入式的接入成本+需要使用显示方式的新增额外的swagger的注解的维护成本，并且注解还带来对API代码或者应用本身的影响的评估，另外生成API文档还是单独需要手工的触发后才能看到API文档。使用Yapi服务端平台方式需要手工方式或者半自动方式把API文档维护到当前平台上，另外还需要新增单独的服务器端容器资源成本部署维护API文档。上述方案或者有较高的人工成本，或者只支持半自动，或者对应用API本身有侵入性的额外维护工作量；或者还需要单独占用的额外的服务器的资源等部分缺陷。

为此，本申请提供了一种微服务API文档生成方案，能够通过无需对API非侵入性的方式来实现API代码和API文档之间的数据一致性，减少维护成本，实现自动化文档生成。

参照图1所示，本发明实施例公开了微服务API文档生成方法，包括：

步骤S11：基于业务开发请求定义相应的API接口协议并开发API代码。

本实施例中，基于业务开发请求定义相应的包含标准API注释的API接口协议，并开发API代码。可以理解的是，在业务开发的API代码侧针对业务开发请求定义相应的包含标准API注释的API接口协议，具体的，如图2所示，通过在定义API接口协议中包含对常规API注释，并且基于业务开发请求开发API代码，可以理解的是，常规API注释是在开发API代码的过程中需要进行的，不属于额外的注释过程，并且标准API注释是对API代码本身是非侵入式，无需引入任何单独的类似注解方式，例如：Swagger接入方式等。只需要常规的编写标准化的Java注释即可，实际上API代码开发本身的闭环中，除了开发代码API本身的实现之外，API本身都需要常规的写注释说明，这并不是额外的新增工作量，以便是代码零侵入。

步骤S12：将所述API代码提交至预设代码库中，触发API文档生成指令。

本实施例中，当将API代码提交至预设代码库中时，也即提交API代码至gitcommit hook中时，自动触发API文档生成指令，以便根据自动触发的API文档生成指令执行相应的程序动作。

步骤S13：执行所述API文档生成指令，以便基于所述API接口协议中的标准API注释以及对应的所述API代码生成对应的API文档。

本实施例中，执行API文档生成指令，具体的，参照图2所示，在内部进行打包API代码，需要注意的是，在API代码打包的同时，前置异步执行包含执行生成API文档的mavenplugin，执行maven plugin相应生成对应的API文档，然后，将API文档和API代码异步自动化完成后，构建相应的镜像，并发布该应用，具体为将API代码功能变化上线，然后另一方面在发布应用的同时异步化自动更新对应的API文档，保证API代码和API文档数据一致性。

本实施例中，解析所述API代码和所述API代码对应的标准API注释，并基于所述API代码和对应的标准API注释执行所述API文档生成指令，输出预设文档格式的API文档。可以理解的是，为了支持开发通过标准化的Java代码+Java doc。具体的，直接通过解析服务以生成对应的API的文档生成，解析传递的API代码和代码对应的标准API注释，然后根据上述API代码和标准API注释执行相应的API文档生成指令，然后输出预设格式的API文档，具体的所述预设格式可以包括但不限于：html、markdown等。例如：生成html型的API文档和生成markdow型的API文档如下：

/生成html型的API文档-示例

mvn gc-java-doc-plugin:html

//生成markdow型的API文档-示例

mvn gc-java-doc-plugin:markdown

直接运用插件命令来生成API文档的html文档或markdown文档。

参照图3所示，本发明实施例公开了一种具体的微服务API文档生成方法，相对于上一实施例，本实施例对技术方案作了进一步的说明和优化。具体的：

步骤S21：基于业务开发请求定义相应的API接口协议并开发API代码。

步骤S22：将所述API代码提交至预设代码库中，触发API文档生成指令。

其中，步骤S21、步骤S22中更加详细的处理过程请参照前述公开的实施例内容，在此不再进行赘述。

步骤S23：执行所述API文档生成指令，基于所述API文档生成指令触发插件执行指令；基于所述插件执行指令控制预先部署的预设API文档生成插件执行所述API文档生成指令，以便输出预设文档格式的API文档。

本实施例中，执行API文档生成指令，触发插件执行指令，所述插件执行指令控制预先部署的API文档生成插件是maven plugin，需要注意的是，该maven plugin在配置完成后，只需要一次的引入后，即可能够应用后面所有API接口使用，无需每一次生成API文档时，进行一次引入，代码引入示例如下：

本实施例中，当触发API代码的变更操作时，在预设代码库中配置提交API代码命令的钩子，并触发包含控制预设API文档生成插件的API代码打包指令。可以理解的是，当使用场景触发API代码的变更，所述API代码的变更具体可以包括但不限于：新增，修改，删除接口API等。配置git commit hook在代码提交后的钩子中，自动的触发打包代码，其中包含执行把API代码生成API文档的功能的maven插件功能，并把生成的API文档放到应用的客服端的工程目录里，等后续的自动触发，构建镜像，发布应用后，这时候就自动化完成了API代码到API文档的自动生成，并持续保持两边的数据一致性，可以直接访问客户端上动态生成的API文档的html或者markdown，不要新增任何为了生成API文档所需要的额外工作，都在开发API代码的过程汇总，自动化的异步闭环完成，并且对API代码的开发是零侵入。

本实施例中，所述基于所述插件执行指令控制预先部署的预设API文档生成插件执行所述API文档生成指令之前，还包括：在代码打包过程中配置插件执行指令。可以理解的是，在代码打包过程中需要配置maven插件执行指令，这样一来，通过内置的插件执行指令，能够在获取到API代码和标准API注释后，自动的触发API文档生成指令，无需手工方式处理，完全自动化生成API文档。

本实施例中，所述触发包含控制预设API文档生成插件的API代码打包指令之后，还包括：构建API文档镜像，基于所述API文档镜像且通过异步自动化同步更新API文档并发布更新后API文档。可以理解的是，当执行打包指令之后，构建相应的镜像，并发布相关应用，以便客户端使用该应用生成API文档，需要注意的是，当API代码功能变化上线时，若API代码出现相应的变化时，通过自动执行maven插件，也能够再次异步化自动完成变化后的API代码的对应API文档更新工作，并同步至客户端。

参照图4所示，当解析Java源文件里上下文生成API文档的服务过程中，将下面的解析+封装生成文档的具体过程的工具服务包装为maven插件，具体的解析流程如下：解析该源文件中API代码文件文身，以获取API代码，然后相应解析标准API注释文件中的各个注释标签，以获取API代码对应的注释标签，所述注释标签可以包括但不限于：@required、@ignore、@mock、@parameterExample、@returnExample等。其中表1为上述注释标签对应的用途。

表1

当解析完成后，将上述解析的API代码和对应的注释标签封装成对应的API文档，以完成封装过程。

由此可见，当开发端新增或修改了API代码，在API代码提交git仓库时，自动化的触发了执行API代码生成API文档的maven插件，构建镜像，发布应用，最后就自动化的更新了生成了对应的API文档，并一直保持API代码和文档的数据一致性，对整个开发API开发同学来说是安全无感知的。

参照图5所示，本发明实施例还相应公开了一种微服务API文档生成装置，包括：

协议代码开发模块11，用于基于业务开发请求定义相应的API接口协议并开发API代码；

指令触发模块12，用于将所述API代码提交至预设代码库中，触发API文档生成指令；

文档生成模块13，用于执行所述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代码零侵入。

在一些具体实施方式中，所述协议代码开发模块11，具体可以包括：

协议代码开发单元，用于基于业务开发请求定义相应的包含标准API注释的API接口协议，并开发API代码。

在一些具体实施方式中，所述文档生成模块13，具体可以包括：

文档生成子模块，用于解析所述API代码和所述API代码对应的标准API注释，并基于所述API代码和对应的标准API注释执行所述API文档生成指令，输出预设文档格式的API文档。

在一些具体实施方式中，所述文档生成子模块，具体可以包括：

文档生成单元，用于执行所述API文档生成指令，基于所述API文档生成指令触发插件执行指令；

在一些具体实施方式中，所述微服务API文档生成装置，具体可以包括：

指令配置单元，用于在代码打包过程中配置插件执行指令。

指令触发单元，用于当触发API代码的变更操作时，在预设代码库中配置提交API代码命令的钩子，并触发包含控制预设API文档生成插件的API代码打包指令。

镜像同步更新单元，用于构建API文档镜像，基于所述API文档镜像且通过异步自动化同步更新API文档并发布更新后API文档。

进一步的，本申请实施例还公开了一种电子设备，图6是根据一示例性实施例示出的电子设备20结构图，图中的内容不能认为是对本申请的使用范围的任何限制。

图6为本申请实施例提供的一种电子设备20的结构示意图。该电子设备20，具体可以包括：至少一个处理器21、至少一个存储器22、电源23、通信接口24、输入输出接口25和通信总线26。其中，所述存储器22用于存储计算机程序，所述计算机程序由所述处理器21加载并执行，以实现前述任一实施例公开的微服务API文档生成方法中的相关步骤。另外，本实施例中的电子设备20具体可以为电子计算机。

本实施例中，电源23用于为电子设备20上的各硬件设备提供工作电压；通信接口24能够为电子设备20创建与外界设备之间的数据传输通道，其所遵循的通信协议是能够适用于本申请技术方案的任意通信协议，在此不对其进行具体限定；输入输出接口25，用于获取外界输入数据或向外界输出数据，其具体的接口类型可以根据具体应用需要进行选取，在此不进行具体限定。

其中，处理器21可以包括一个或多个处理核心，比如4核心处理器、8核心处理器等。处理器21可以采用DSP(Digital Signal Processing，数字信号处理)、FPGA(Field－Programmable Gate Array，现场可编程门阵列)、PLA(Programmable Logic Array，可编程逻辑阵列)中的至少一种硬件形式来实现。处理器21也可以包括主处理器和协处理器，主处理器是用于对在唤醒状态下的数据进行处理的处理器，也称CPU(Central ProcessingUnit，中央处理器)；协处理器是用于对在待机状态下的数据进行处理的低功耗处理器。在一些实施例中，处理器21可以在集成有GPU(Graphics Processing Unit，图像处理器)，GPU用于负责显示屏所需要显示的内容的渲染和绘制。一些实施例中，处理器21还可以包括AI(Artificial Intelligence，人工智能)处理器，该AI处理器用于处理有关机器学习的计算操作。

另外，存储器22作为资源存储的载体，可以是只读存储器、随机存储器、磁盘或者光盘等，其上所存储的资源可以包括操作系统221、计算机程序222等，存储方式可以是短暂存储或者永久存储。

其中，操作系统221用于管理与控制电子设备20上的各硬件设备以及计算机程序222，以实现处理器21对存储器22中海量数据223的运算与处理，其可以是Windows Server、Netware、Unix、Linux等。计算机程序222除了包括能够用于完成前述任一实施例公开的由电子设备20执行的微服务API文档生成方法的计算机程序之外，还可以进一步包括能够用于完成其他特定工作的计算机程序。数据223除了可以包括电子设备接收到的由外部设备传输进来的数据，也可以包括由自身输入输出接口25采集到的数据等。

进一步的，本申请还公开了一种计算机可读存储介质，用于存储计算机程序；其中，所述计算机程序被处理器执行时实现前述公开的微服务API文档生成方法。关于该方法的具体步骤可以参考前述实施例中公开的相应内容，在此不再进行赘述。

本说明书中各个实施例采用递进的方式描述，每个实施例重点说明的都是与其它实施例的不同之处，各个实施例之间相同或相似部分互相参见即可。对于实施例公开的装置而言，由于其与实施例公开的方法相对应，所以描述的比较简单，相关之处参见方法部分说明即可。

专业人员还可以进一步意识到，结合本文中所公开的实施例描述的各示例的单元及算法步骤，能够以电子硬件、计算机软件或者二者的结合来实现，为了清楚地说明硬件和软件的可互换性，在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行，取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能，但是这种实现不应认为超出本申请的范围。结合本文中所公开的实施例描述的方法或算法的步骤可以直接用硬件、处理器执行的软件模块，或者二者的结合来实施。软件模块可以置于随机存储器(RAM)、内存、只读存储器(ROM)、电可编程ROM、电可擦除可编程ROM、寄存器、硬盘、可移动磁盘、CD-ROM、或技术领域内所公知的任意其它形式的存储介质中。

最后，还需要说明的是，在本文中，诸如第一和第二等之类的关系术语仅仅用来将一个实体或者操作与另一个实体或操作区分开来，而不一定要求或者暗示这些实体或操作之间存在任何这种实际的关系或者顺序。而且，术语“包括”、“包含”或者其任何其他变体意在涵盖非排他性的包含，从而使得包括一系列要素的过程、方法、物品或者设备不仅包括那些要素，而且还包括没有明确列出的其他要素，或者是还包括为这种过程、方法、物品或者设备所固有的要素。在没有更多限制的情况下，由语句“包括一个……”限定的要素，并不排除在包括所述要素的过程、方法、物品或者设备中还存在另外的相同要素。

以上对本发明所提供的一种微服务API文档生成方法、装置、设备、存储介质进行了详细介绍，本文中应用了具体个例对本发明的原理及实施方式进行了阐述，以上实施例的说明只是用于帮助理解本发明的方法及其核心思想；同时，对于本领域的一般技术人员，依据本发明的思想，在具体实施方式及应用范围上均会有改变之处，综上所述，本说明书内容不应理解为对本发明的限制。

Claims

1.一种微服务API文档生成方法，其特征在于，包括：

基于业务开发请求定义相应的API接口协议并开发API代码；

将所述API代码提交至预设代码库中，触发API文档生成指令；

2.根据权利要求1所述的微服务API文档生成方法，其特征在于，所述基于业务开发请求定义相应的API接口协议并开发API代码，包括：

3.根据权利要求1所述的微服务API文档生成方法，其特征在于，所述执行所述API文档生成指令，以便基于所述API接口协议中的标准API注释以及对应的所述API代码生成对应的API文档，包括：

4.根据权利要求3所述的微服务API文档生成方法，其特征在于，所述基于所述API代码和对应的标准API注释执行所述API文档生成指令，输出预设文档格式的API文档，包括：

5.根据权利要求4所述的微服务API文档生成方法，其特征在于，所述基于所述插件执行指令控制预先部署的预设API文档生成插件执行所述API文档生成指令之前，还包括：

在代码打包过程中配置插件执行指令。

6.根据权利要求1至5任一项所述的微服务API文档生成方法，其特征在于，还包括：

7.根据权利要求6所述的微服务API文档生成方法，其特征在于，所述触发包含控制预设API文档生成插件的API代码打包指令之后，还包括：

8.一种微服务API文档生成装置，其特征在于，包括：

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

存储器，用于保存计算机程序；

处理器，用于执行所述计算机程序，以实现如权利要求1至7任一项所述的微服务API文档生成方法的步骤。

10.一种计算机可读存储介质，其特征在于，用于存储计算机程序；其中，所述计算机程序被处理器执行时实现如权利要求1至7任一项所述的微服务API文档生成方法的步骤。