[发明专利]文档生成方法、系统、设备及可读存储介质

说明书

本发明公开了一种文档生成方法，包括：获取预设开发框架中的处理器类；通过预设的方法解析器对所述处理器类中的各个所述方法进行解析，生成所述应用程序接口的注解集及数据集；通过所述预设开发框架中的应用程序接口解析器对各个所述应用程序接口对应的注解信息及数据信息进行解析，并将提取出的各个所述应用程序接口对应的第一应用程序接口信息及第二应用程序接口信息进行组合，得到各个所述应用程序接口对应的目标接口信息；将各个所述应用程序接口对应的目标接口信息按照预设格式进行序列化，生成应用程序接口文档。本发明实施例使开源产品能够适配使用现有的开发框架进行应用程序接口加载管理，同时正确生成对应的应用程序接口文档。

技术领域

本发明涉及软件开发领域，具体涉及一种文档生成方法、系统、设备及可读存储介质。

背景技术

应用程序接口(Application Programming Interface，API)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码或理解内部工作机制的细节。

API文档是一个关于API的技术内容交付文件，包含如何有效地使用和集成API的说明。它是一个简明的参考手册，包含了使用API所需的所有信息，详细介绍了函数、类、返回类型、参数等。

传统的Swagger API文档生成方法可以是人工进行Swagger API文档的编写，或者基于SpringMVC3.1之后的版本所对应的系统进行开发生成，其中，Swagger是一个规范且完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。

然而，针对上述做法，发明人发现，传统的Swagger API文档生成方法由于SpringMVC3.1之后的版本对整个内存对象做了重大变更，与之前的版本差异很大，导致开源产品均无法适配使用HandlerMapping接口的实现类，比如类DefaultAnnotationHandlerMapping，进行API加载管理，使系统无法正确生成对应的Swagger API文档。

发明内容

本发明的目的在于提供一种文档生成方法、系统、计算机设备及可读存储介质，用于解决现有技术中基于SpringMVC3.1之后的版本所对应的系统进行开发时，开源产品均无法适配使用HandlerMapping接口的实现类进行API加载管理，使系统无法正确生成对应的Swagger API文档的缺陷。

根据本发明的一个方面，提供了一种文档生成方法，该方法包括如下步骤：

获取预设开发框架中的处理器类，其中，所述处理器类包括一个或多个方法，所述方法包括一个或多个应用程序接口；

通过预设的方法解析器对所述处理器类中的各个所述方法进行解析，生成各个所述应用程序接口的注解集及数据集，所述注解集包括各个所述应用程序接口对应的注解信息，所述数据集包括各个所述应用程序接口对应的数据信息；

通过所述预设开发框架中的应用程序接口解析器对各个所述应用程序接口对应的注解信息及数据信息进行解析，以提取出各个所述应用程序接口对应的第一应用程序接口信息及第二应用程序接口信息；

将所述第一应用程序接口信息及所述第二应用程序接口信息进行组合，得到各个所述应用程序接口对应的目标接口信息；

将各个所述应用程序接口对应的目标接口信息按照预设格式进行序列化，生成应用程序接口文档。

可选地，所述应用程序接口解析器包括第一应用程序接口解析器，所述第一应用程序接口信息包括第一目标接口信息，所述通过所述预设开发框架中的应用程序接口解析器对各个所述应用程序接口对应的注解信息及数据信息进行解析，以提取出各个所述应用程序接口对应的第一应用程序接口信息，包括：