[发明专利]一种基于eclipse生成接口文档的方法在审
| 申请号： | 201910816434.1 | 申请日： | 2019-08-30 |
| 公开（公告）号： | CN110532028A | 公开（公告）日： | 2019-12-03 |
| 发明（设计）人： | 李虎;曾毅峰;刘佳利;彭乐乐 | 申请（专利权）人： | 上海浦东发展银行股份有限公司信用卡中心 |
| 主分类号： | G06F8/73 | 分类号： | G06F8/73;G06F8/30 |
| 代理公司： | 31225 上海科盛知识产权代理有限公司 | 代理人： | 叶敏华<国际申请>=<国际公布>=<进入 |
| 地址： | 200120 上海市浦东新区中*** | 国省代码： | 上海;31 |
| 权利要求书： | 查看更多 | 说明书： | 查看更多 |
| 摘要： | |||
| 搜索关键词： | 接口文档 筛选 接口类 改造 插件功能 方法参数 工作效率 快速生成 扩展插件 位置记录 重复操作 一次性 文档 预设 调用 配置 返回 | ||
1.一种基于eclipse生成接口文档的方法，其特征在于，包括以下步骤：
S1、调用eclipse扩展插件；
S2、筛选接口类；
S3、从筛选得到的接口类中，筛选出mapping接口；
S4、判断筛选得到的mapping接口是否需要改造，若判断为是，则执行步骤S5，否则执行步骤S7；
S5、对mapping接口进行相应的swagger配置；
S6、对mapping接口的方法参数进行相应的swagger配置，之后在该mapping接口预设的位置记录改造标记；
S7、判断是否完成对所有mapping接口的改造，若判断为是，则执行步骤S8，否则返回步骤S2；
S8、生成接口文档。
2.根据权利要求1所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S2具体是筛选出使用springmvc框架定义的接口类。
3.根据权利要求1所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S3具体是从筛选得到的接口类中，使用jdt解析筛选出对应的mapping接口。
4.根据权利要求1所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S4具体是判断筛选得到的mapping接口是否存在改造标记，若不存在改造标记，则该mapping接口需要改造，执行步骤S5；若存在改造标记，则该mapping接口不需要改造，执行步骤S7。
5.根据权利要求1所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S5具体包括以下步骤：
S51、通过jdt解析mapping接口类文件，得到对应的mapping接口方法；
S52、对mapping接口方法进行swagger配置相关的代码改造，完成对mapping接口相应的swagger配置。
6.根据权利要求1所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S6具体包括以下步骤：
S61、筛选mapping接口对应的方法参数，得到基本形参和对象形参；
S62、分别对基本形参和对象形参进行swagger配置，完成对mapping接口的方法参数进行相应的swagger配置；
S63、在该mapping接口预设的位置记录改造标记。
7.根据权利要求6所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S62中对基本形参进行swagger配置具体是直接为基本形参增加swagger配置。
8.根据权利要求6所述的一种基于eclipse生成接口文档的方法，其特征在于，所述步骤S62中对对象形参进行swagger配置的具体过程为：
S621、寻找对象形参类文件；
S622、通过jdt解析对象形参类文件，得到对应的对象属性；
S623、为对象属性增加swagger配置。
该专利技术资料仅供研究查看技术是否侵权等信息，商用须获得专利权人授权。该专利全部权利属于上海浦东发展银行股份有限公司信用卡中心，未经上海浦东发展银行股份有限公司信用卡中心许可，擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作，请联系【客服】
本文链接：http://www.vipzhuanli.com/pat/books/201910816434.1/1.html，转载请声明来源钻瓜专利网。
