swagger+springmvc使用

为了方便的管理项目中API接口，

以及测试人员的调试，故引入swagger生成接口文档。

以下是swagger+springmvc使用步骤：

一、在pom.xml中引入maven依赖。

<!-- springfox start -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.4.0</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.4.0</version>
</dependency>

<!--  springfox end  -->

二、添加自定义SwaggerConfig.java类文件，文件内容如下：

三、将上一步中SwaggerConfig配置加入Spring容器中（applicaitionContext.xml），如下：

<!--  springfox配置  -->
<bean class="com.qitoon.openapi.common.conf.SwaggerConfig"/>  

四、为了访问swagger-ui.html等静态资源，需在dispatcher-servlet.xml中加入如下配置：

<!--   静态资源访问  -->
< mvc :resources  mapping ="/**"  location ="/" />

五、如有全局拦截器，需要放开以下路径，在dispatcher-servlet.xml中加入如下配置：

< mvc:exclude-mapping path="/swagger-ui.html"/>
< mvc:exclude-mapping path="/webjars/**"/>

如图：

六、在Controller中添加Swagger相关注解，配置如下：

1、controller注解使用

注意：

1、如果方法参数是对象接收，GET请求使用@ModelAttribute注解，POST请求使用@RequestBody 注解；

七、部署项目，访问以下地址：

http://host:port/swagger-ui.html

swagger对应页面效果如图：

资料信息

swagger-wiki文档

https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X