[发明专利]一种基于eclipse生成接口文档的方法

说明书

本发明涉及一种基于eclipse生成接口文档的方法，包括以下步骤：S1、调用eclipse扩展插件；S2、筛选接口类；S3、从筛选得到的接口类中，筛选出mapping接口；S4、判断筛选得到的mapping接口是否需要改造，若判断为是，则执行步骤S5，否则执行步骤S7；S5、对mapping接口进行相应的swagger配置；S6、对mapping接口的方法参数进行相应的swagger配置，之后在该mapping接口预设的位置记录改造标记；S7、判断是否完成对所有mapping接口的改造，若判断为是，则执行步骤S8，否则返回步骤S2；S8、生成接口文档。与现有技术相比，本发明利用eclipse平台的插件功能，能够对现有文档进行一次性批量改造，实现自动快速生成接口文档的目的，相比于传统手动重复操作，有效降低了操作繁琐程度、提高了工作效率。

技术领域

本发明涉及软件开发技术领域，尤其是涉及一种基于eclipse生成接口文档的方法。

背景技术

为解决传统一体化架构的不灵活、不可扩展及迭代速度慢等缺点，出现了一种新的软件架构方式——微服务，具体来说，微服务架构将应用和服务分解成更小的、松散耦合的组件，在微服务架构中，每个服务都是自我包含的，并且具有单一的业务功能，使用微服务架构后，每个功能都被分配给了不同的微服务，这些微服务会处理它们自己的数据、执行不同的功能，这些由微服务执行的功能通过API(Application Programming Interface，应用程序接口)传达给用户，所有内部节点都被连接到API，而所有连接到API的用户都会自动与系统连接。

微服务架构实际是一种前后端分离架构，前后端分离的设计使得前端与后端、后端与后端之间的交互变得越来越频繁，因此接口文档的编写、维护、实时更新也就越发重要。常规的创建文档、编辑文档，以及借助版本控制保存文档的方式，只能对接口文档的存储进行管理；此外，在实际应用中，接口都是经常变化的，这就需要接口编写者及时更新接口文档，但是频繁地更新接口文档必然会花费大量的开发时间。swagger的出现在某种程度上解决了这些问题，swagger提供了一套完整的接口文档解决方案，用于生成、描述、调用和可视化RESTful风格的Web服务，通过将文件的方法、参数和模型紧密集成到服务器端的代码，从而使API始终保持同步更新。

但是现存的大量系统并未都接入swagger，如图1所示，在生成接口文档时，需要判断该接口文档是否进行过swagger配置，若判断为是，则需要依次对指定接口及方法、指定接口参数对象增加注解；

若判断为否，则需要先引入swagger相关jar包，之后添加文档摘要相关配置类，再依次对所有接口及方法、所有接口参数对象增加注解；

在手动重复上述步骤之后，最终将生成的接口文档以Web-UI形式展示给用户。

可见，现有的生成接口文档方法是一种采用人工手动方式进行重复操作的方法，需要对存量的接口挨个进行改造，这必然会增加开发人员的工作繁琐程度、降低工作效率，而依靠手动的操作方式，在操作过程中可能出现差错，最终导致生成接口文档失败，不利于接口文档的升级迭代。

发明内容

本发明的目的就是为了克服上述现有技术存在的缺陷而提供一种基于eclipse生成接口文档的方法，利用eclipse开发平台的插件功能，实现自动生成接口文档的目的。

本发明的目的可以通过以下技术方案来实现：一种基于eclipse生成接口文档的方法，包括以下步骤：

S1、调用eclipse扩展插件；

S2、筛选接口类；

S3、从筛选得到的接口类中，筛选出mapping接口；

S4、判断筛选得到的mapping接口是否需要改造，若判断为是，则执行步骤S5，否则执行步骤S7；