一种Swagger接口文档工具及其使用方法技术

本发明专利技术涉及一种Swagger接口文档工具及其使用方法，该工具包括扫描模块、处理模块、展示模块、测试模块，所述扫描模块、展示模块、测试模块分别与处理模块连接；该使用方法先通过扫描模块，扫描语言中有关接口信息的部分及额外的扩展信息；再通过处理模块，对所有信息进行梳理、筛选、定义、重组，组织处理该产品可识别的信息；然后，通过展示模块，将整理出的信息通过页面的方法展现出来；使用者通过测试模块能进行测试；本发明专利技术彻底脱离java业务代码限制，不再和业务代码或系统有任何的牵连，不再有现有技术中存在的安全问题，同时，页面友好、易用，保留足够的扩展性，能够适应多样的接口验证限制，彻底提高软件开发效率，是真正的软件生产力工具。

A document tool of swagger interface and its usage

【技术实现步骤摘要】
一种Swagger接口文档工具及其使用方法
本专利技术涉及Java开发
，具体地说是一种Swagger接口文档工具及其使用方法。
技术介绍
Swagger的目标是为RESTAPIs定义一个标准的，与语言无关的接口，使人和计算机在看不到源码、看不到文档或者不能通过网络流量检测的情况下，能发现和理解各种服务的功能。当服务通过Swagger定义，消费者就能与远程的服务互动通过少量的实现逻辑，类似于低级编程接口，Swagger去掉了调用服务时的很多猜测。在Java开发领域中，服务调用时，需要悉知接口的所有信息，接口的对接也只是软件开发中的一个步骤。但是目前现有的技术，都是将接口开发文档发布到实际的生产环境中，导致生产环境的冗余和不安全性，同时也占用了一定的硬件资源，这部分资源其实就是完全的被浪费掉了。现有的Swagger使用不够方便，对语言的侵入性很高；现有Swagger的页面不够友好，使用困难，扩展性不够；现有的Swagger对接口进行调试时，能力有限，不能完全的使用接口验证。因此，如何提供一种Swagger接口文档工具本文档来自技高网...

【技术保护点】
1.一种Swagger接口文档工具，其特征在于，包括扫描模块、处理模块、展示模块、测试模块，所述扫描模块、展示模块、测试模块分别与所述处理模块连接。/n

【技术特征摘要】
1.一种Swagger接口文档工具，其特征在于，包括扫描模块、处理模块、展示模块、测试模块，所述扫描模块、展示模块、测试模块分别与所述处理模块连接。


2.根据权利要求1所述的Swagger接口文档工具，其特征在于，所述扫描模块包括关键字搜索和字段搜索模块；
所述关键字搜索是对web框架的restful接口关键字进行搜索；
所述字段搜索模块是基于java反射机制的原生字段进行搜索。


3.根据权利要求1所述的Swagger接口文档工具，其特征在于，所述处理模块包括分析模块、组织模块、存储模块及索引模块。


4.根据权利要求3所述的Swagger接口文档工具，其特征在于，所述分析模块为代码注释分析，所述组织模块为对主体数据进行组织，所述存储模块为B+树数据结构，所述索引模块为B+树构建数据。


5.根据权利要求1-4任一项所述的Swagger接口文档工具，其特征在于，所述展示模块是采用Web页面展示服务的方式，所述测试模块是采用接口模拟Http测试的方式。


6.根据权利要求1-5任一项所述Swagger接口文档工具的使用方法，其特征在于，包括以下步骤：
101、先通过扫描模块，扫描语言中有关接口信息的部分，以及额外的一些扩展信息；
102、通过处理模块，对所有信息进行梳理、筛选、定义、重组，组织处理该产品可识别的信息；
103、通过展示模块，将整理出的信息通过页面的方法展现出来；
104、使用测试模块...

【专利技术属性】
技术研发人员：蒋时华，
申请(专利权)人：苏州海管家物流科技有限公司，
类型：发明
国别省市：江苏;32