[发明专利]微服务框架的接口文档生成方法、电子设备及存储介质

说明书

本发明公开一种微服务框架的接口文档生成方法，所述方法基于Spr i ng C l oud微服务框架，该方法包括：扫描带有业务层组件注解的类，获取所述带有业务层组件注解的类中的预定方法信息；依据所述预定方法信息构建控制层处理请求的URL；为所述预定方法创建控制层中的接口方法，并为所述接口方法的各个参数添加注解；根据所述控制层处理请求的URL及所述接口方法的各个参数添加的注解生成所述接口文档。通过本发明根据业务层代码自动生成Contro l l er层代码，开发人员无需编写Contro l l er层代码，可以减少开发工作量，提高开发效率。

技术领域

本发明涉及前后端分离开发的模式，具体的说是一种基于微服务框架的接口文档生成方法、电子装置及存储介质。

背景技术

在Spring Cloud微服务体系下，服务采用MVC分层架构，在控制层即Controller层,需要编写代码调用业务层接口，给开发人员带来了额外的开发工作量，为此如何避免开发人员编写Controller层代码，减少开发工作量，提高开发效率成为本领域亟待解决的技术问题。

发明内容

为了改善相关技术中的不足，本发明第一方面致力于提供一种微服务框架的接口文档生成方法，所述方法基于Spring Cloud微服务框架，该方法包括：

扫描带有业务层组件注解的类，获取所述带有业务层组件注解的类中的预定方法信息；

依据所述预定方法信息构建控制层处理请求的URL；

为所述预定方法创建控制层中的接口方法，并为所述接口方法的各个参数添加注解；

根据所述控制层处理请求的URL及所述接口方法的各个参数添加的注解生成所述接口文档。

进一步的，根据所述控制层处理请求的URL及所述接口方法的各个参数添加的注解生成所述接口文档包括：为所述预设方法添加MVC请求注解，其中请求类型均为POST类型。

其中，所述预定方法信息包括方法名和方法参数。

其中当所述接口方法的参数类型为基本类型和包装类时，配置@RequestParams注解；当所述接口方法的参数为对象类型时，配置@RequestBody注解。

具体的，依据所述预定方法信息构建控制层处理请求的URL规则为：/接口名/接口方法名_参数类型1_参数类型2。

具体的，所述预定方法为公有方法。

具体的，所述接口文档为Restful接口文档。

具体的，利用反射机制获取所述带有业务层组件注解的类中的预定方法信息。

本发明的另一方面提供一种电子设备，包括：

一个或多个处理器；

存储器；

一个或多个应用程序，其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行，所述一个或多个程序配置用于：执行上述任一项所述的微服务框架的接口文档生成方法。

本发明的第三个方面提供一种计算机可读存储介质，所述计算机存储介质用于存储计算机指令，当其在计算机上运行时，使得计算机可以执行上述任一项所述的微服务框架的接口文档生成方法。

根据本发明提供的所述的微服务框架的接口文档生成方法、电子设备和计算机可读存储介质，通过根据业务层代码自动生成Controller层代码，开发人员无需编写Controller层代码，可以减少开发工作量，提高开发效率。

附图说明

图1为本发明基于Spring Cloud微服务框架的接口文档生成方法示意图