一种项目文档自动化生成方法、设备及存储介质技术

本发明专利技术公开了一种项目文档自动化生成方法、设备及存储介质，包括：执行项目文档生成指令，通过预设插件生成项目描述文件和配置文件；预设插件将生成的项目描述文件和本地接口文档文件发送至对应的代码托管服务器，并根据项目的唯一ID号存储至对应的文件夹。通过预设插件直接生成项目所需的配置文件，无需对每个项目文档的代码进行单独配置文件信息，实现集中配置管理。本地接口文档文件生成过程无需项目注释侵入到业务代码中，可实现独立部署，如果项目中断或停止，依旧可以访问生成的本地接口文档文件。将生成的项目文档发送至对应的代码托管服务器对分散的本地接口文档文件进行统一存储分类，实现集中管理。实现集中管理。实现集中管理。

【技术实现步骤摘要】
一种项目文档自动化生成方法、设备及存储介质


[0001]本专利技术涉及数据处理
，特别是涉及一种项目文档自动化生成方法、设备及存储介质。

技术介绍

[0002]项目是指一系列独特的、复杂的并相互关联的活动，这些活动有着一个明确的目标或目的，必须在特定的时间、预算、资源限定内依据规范完成。针对一个目标项目而言，目标项目一般包括至少一个项目任务，对目标项目的管理是基于对该目标项目中项目任务的管理。针对每一个项目任务，可以由负责该项目任务的相关人员对该项目任务制定计划、指定资源、管理进度等。在现有技术中，针对一项项目任务，一般均需要创建诸如需求文档、设计文档、任务进度追踪文档、测试用例文档、缺陷记录文档等多种文档，而这些文档一般是独立的文档，分别由不同的人员进行维护和管理。
[0003]目前，业界常用的技术手段是引入swagger框架，基于swagger使用规范，在项目代码中配置swagger信息及在每个需要生成文档的接口上使用swagger注解。由于swagger配置信息需要在每个项目代码中进行单独配置，难以实现集中配置管理。为了能够直接生成本地接口文档文件，还需要在代码中提前写大量的注解，生成的本地接口文档越清晰，写的注解越多。且如果是与服务端代码集成，直接嵌入到工程代码中，侵入性比较大，将文档参数和应用参数杂糅在一起，不易阅读，而且生成的本地接口文档文件依赖于项目，无法独立部署。如果项目中止，与之相关的项目文档文件也无法访问，难以实现对项目文档文件的集中管理和查看。

技术实现思路

[0004]本专利技术要解决的技术问题是：解决各个项目接口文档分散，不便于统一查阅的问题，实现文档的集中管理和查看。
[0005]为了解决上述技术问题，本专利技术提供了一种项目文档自动化生成方法、设备及存储介质，包括执行第一项目文档生成指令，以使第一预设插件生成第一项目描述文件和配置文件信息；
[0006]获取第一项目注释，基于所述第一项目注释和所述配置文件生成本地接口文档文件并发送至预设位置，以使所述第一预设插件在所述预设位置处直接读取所述本地接口文档文件，并将所述第一项目描述文件和所述本地接口文档文件发送至对应的代码托管服务器，以供所述代码托管服务器对所述第一项目描述文件和所述本地接口文档文件进行统一存储分类。
[0007]进一步的，执行项目文档生成指令，以使第一预设插件生成配置文件信息，具体为：
[0008]获取所述第一项目文档生成指令，根据所述第一项目文档生成指令控制所述第一预设插件在编译阶段生成所述第一项目所需的配置文件，其中，所述配置文件，用于存放所
述第一项目的属性参数信息，且所述配置文件包括Maven Plugin配置文件和smart－doc.json配置文件。
[0009]进一步的，所述第一项目描述文件，具体为：
[0010]所述第一项目描述文件用于存储项目信息；其中，所述项目信息包括：所述第一项目的名称、所述第一项目对应的唯一ID号和所述第一项目的存储地址。
[0011]进一步的，所述代码托管服务器对所述第一项目描述文件和所述本地接口文档文件进行统一存储分类，具体为：
[0012]所述代码托管服务器按照项目的唯一ID进行分类归档，并将所述第一项目描述文件和所述本地接口文档文件按照对应的项目ID存储至对应的文件夹。
[0013]进一步的，将所述第一项目描述文件和所述本地接口文档文件发送至对应的代码托管服务器进行统一存储分类后，还包括：
[0014]所述第一预设插件对所述第第一项目描述文件和所述本地接口文档文件进行实时监测，当检测到所述第一项目描述文件和所述本地接口文档文件内容发生修改变动时，会自动将更新后的文件发送至所述代码托管服务器。
[0015]进一步的，所述项目文档自动化生成方法还包括：
[0016]接收用户的文档查阅请求，生成登录注册界面，根据用户输入信息判断用户是否有文档查阅权限，若是，根据所述文档查阅请求调取对应的文档进行显示，若否，则拒绝此次文档查阅请求。
[0017]进一步的，所述项目文档自动化生成方法还包括：
[0018]通过输入项目ID号检索查询上传至所述代码托管服务器的所述第一项目描述文件和所述本地接口文档文件，和/或通过输入关键词的形式进行检索查询。
[0019]相应的，本专利技术实施例还提供了一种终端设备，包括处理器、存储器以及存储在所述存储器中且被配置为由所述处理器执行的计算机程序，所述处理器执行所述计算机程序时实现如上所述的项目文档自动化生成方法。
[0020]相应的，本专利技术实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质包括存储的计算机程序，其中，在所述计算机程序运行时控制所述计算机可读存储介质所在设备执行如上所述的项目文档自动化生成方法。
[0021]本专利技术实施例一种项目文档自动化生成方法、设备及可读存储介质，与现有技术相比，其有益效果在于：
[0022]执行项目文档生成指令，通过预设插件直接生成项目描述文件和所需的配置文件；基于预先撰写的项目注释和所述配置文件生成本地接口文档文件，通过预设插件将生成的项目描述文件和本地接口文档文件发送至对应的代码托管服务器进行统一存储分类，对分散的本地接口文档文件实现集中管理。通过预设插件直接生成项目所需的配置文件，无需对每个项目文档的代码进行单独配置文件信息，实现集中配置管理，基于项目注释和所述配置文件生成本地接口文档文件，无需将项目注释侵入到业务代码中，可实现独立部署，如果项目中断或停止，依旧可以访问生成的本地接口文档文件。
[0023]此外，本专利技术实施例的预设插件还对项目描述文件和本地接口文档文件进行实时监测，当检测到项目描述文件和本地接口文档文件内容发生修改变动时，会自动将更新后的文件发送至所述代码托管服务器，方便用户获取最新的文档的记录。在用户进行文档查
阅时还提供用户鉴权和检索功能，在避免项目文档泄露的同时还可提升文档查阅的便利性。
附图说明
[0024]图1是本专利技术实施例提供的一种项目文档自动化生成方法的流程示意图。
具体实施方式
[0025]下面将结合本专利技术中的附图，对本专利技术中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本专利技术一部分实施例，而不是全部的实施例。基于本专利技术中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本专利技术保护的范围。
[0026]实施例1
[0027]参见图1，图1是本专利技术实施例提供的一种项目文档自动化生成方法、设别及存储介质的流程示意图，该方法包括步骤101和步骤102，各项步骤具体如下：
[0028]步骤101，执行第一项目文档生成指令，以使第一预设插件生成第一项目描述文件和配置文件。
[0029]在本专利技术实施例中，用户可通过IDEA(IntelliJ IDEA，java开发工具软件)发布项目文档生成指令，对项目名称以及存储路径等基本信息进行设本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种项目文档自动化生成方法，其特征在于，包括：执行第一项目文档生成指令，以使第一预设插件生成第一项目描述文件和配置文件；获取第一项目注释，基于所述第一项目注释和所述配置文件生成本地接口文档文件并发送至预设位置，以使所述第一预设插件在所述预设位置处直接读取所述本地接口文档文件，并将所述第一项目描述文件和所述本地接口文档文件发送至对应的代码托管服务器，以供所述代码托管服务器对所述第一项目描述文件和所述本地接口文档文件进行统一存储分类。2.如权利要求1所述的一种项目文档自动化生成方法，其特征在于，执行项目文档生成指令，以使第一预设插件生成配置文件，具体为：获取所述第一项目文档生成指令，根据所述第一项目文档生成指令控制所述第一预设插件在编译阶段生成所述第一项目所需的配置文件，其中，所述配置文件，用于存放所述第一项目的属性参数信息，且所述配置文件包括Maven Plugin配置文件和smart－doc.json配置文件。3.如权利要求1所述的一种项目文档自动化生成方法，其特征在于，所述第一项目描述文件，具体为：所述第一项目描述文件用于存储项目信息；其中，所述项目信息包括：所述第一项目的名称、所述第一项目对应的唯一ID号和所述第一项目的存储地址。4.如权利要求1所述的一种项目文档自动化生成方法，其特征在于，所述代码托管服务器对所述第一项目描述文件和所述本地接口文档文件进行统一存储分类，具体为：所述代码托管服务器按照项目的唯一ID进行分类归档，并将所述第一项目描述文件和所述本地接口文档文件按照对...

【专利技术属性】
技术研发人员：吴俊乐，罗飘，罗小龙，
申请(专利权)人：广东南方新媒体科技有限公司，
类型：发明
国别省市：