[发明专利]微服务框架的接口文档生成方法、电子设备及存储介质在审
申请号: | 202110084056.X | 申请日: | 2021-01-21 |
公开(公告)号: | CN112783551A | 公开(公告)日: | 2021-05-11 |
发明(设计)人: | 郝彬;刘文涛;徐晓剑;杨明;马晶 | 申请(专利权)人: | 中信银行股份有限公司 |
主分类号: | G06F8/73 | 分类号: | G06F8/73;G06F16/955 |
代理公司: | 北京市兰台律师事务所 11354 | 代理人: | 张峰 |
地址: | 100020 北京市朝*** | 国省代码: | 北京;11 |
权利要求书: | 查看更多 | 说明书: | 查看更多 |
摘要: | |||
搜索关键词: | 微服 框架 接口 文档 生成 方法 电子设备 存储 介质 | ||
1.一种微服务框架的接口文档生成方法,所述方法基于Spring Cloud微服务框架,其特征在于该方法包括:
扫描带有业务层组件注解的类,获取所述带有业务层组件注解的类中的预定方法信息;
依据所述预定方法信息构建控制层处理请求的URL;
为所述预定方法创建控制层中的接口方法,并为所述接口方法的各个参数添加注解;
根据所述控制层处理请求的URL及所述接口方法的各个参数添加的注解生成所述接口文档。
2.根据权利要求1所述的微服务框架的接口文档生成方法,其特征在于,根据所述控制层处理请求的URL及所述接口方法的各个参数添加的注解生成所述接口文档包括:为所述预设方法添加MVC请求注解,其中请求类型均为POST类型。
3.根据权利要求1所述的微服务框架的接口文档生成方法,其特征在于,所述预定方法信息包括方法名和方法参数。
4.根据权利要求1所述的微服务框架的接口文档生成方法,其特征在于,所述接口方法的参数类型为基本类型和包装类时,配置@RequestParams注解;当所述接口方法的参数为对象类型时,配置@RequestBody注解。
5.根据权利要求1所述的微服务框架的接口文档生成方法,其特征在于,依据所述预定方法信息构建控制层处理请求的URL规则为:/接口名/接口方法名_参数类型1_参数类型2。
6.根据权利要求1所述的微服务框架的接口文档生成方法,其特征在于,所述预定方法为公有方法。
7.根据权利要求1至6任一项所述的微服务框架的接口文档生成方法,其特征在于,所述接口文档为Restful接口文档。
8.根据权利要求1至6任一项所述的微服务框架的接口文档生成方法,其特征在于,利用反射机制获取所述带有业务层组件注解的类中的预定方法信息。
9.一种电子设备,其特征在于,包括:
一个或多个处理器;
存储器;
一个或多个应用程序,其中所述一个或多个应用程序被存储在所述存储器中并被配置为由所述一个或多个处理器执行,所述一个或多个程序配置用于:执行根据权利要求1至8任一项所述的微服务框架的接口文档生成方法。
10.一种计算机可读存储介质,其特征在于,所述计算机存储介质用于存储计算机指令,当其在计算机上运行时,使得计算机可以执行上述权利要求1至8中任一项所述的微服务框架的接口文档生成方法。
该专利技术资料仅供研究查看技术是否侵权等信息,商用须获得专利权人授权。该专利全部权利属于中信银行股份有限公司,未经中信银行股份有限公司许可,擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作,请联系【客服】
本文链接:http://www.vipzhuanli.com/pat/books/202110084056.X/1.html,转载请声明来源钻瓜专利网。