spring mvc 4 + swagger2

最新推荐文章于 2019-11-29 16:53:50 发布

山闻愚

最新推荐文章于 2019-11-29 16:53:50 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

分类专栏：综合

本文链接：https://blog.youkuaiyun.com/xjj1314/article/details/78192398

综合专栏收录该内容

13 篇文章

订阅专栏

本文详细介绍如何在项目中使用Springfox集成Swagger2，包括引入依赖、配置Swagger、注册配置类、配置静态资源及web.xml等步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

其他不多说了，直接上步骤。

1、引入包

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
</dependency>

2、配置类

/**
* <p>Title: Swagger配置类<／p>
* <p>Description: <／p>
* @author swy
* @date 2017年10月10日
* @version 1.0
*/
@EnableWebMvc
@EnableSwagger2
@ComponentScan(basePackages = {"com.intetex.controller"})
@Configuration
public class SwaggerConfig {

@Bean
public Docket createDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("admin")
.select()
.apis(RequestHandlerSelectors.basePackage("com.intetex.controller")) // 注意修改此处的包名
.paths(PathSelectors.any())
.build();
}

private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("INTETEX ADMIN RESTful APIs")
.description("兄弟纺织网后台管理 RESTful APIs")
.termsOfServiceUrl("http://www.intetex.com/")
//.contact("程序猿DD")
.version("1.1.0")
.build();
}
}

3、注册配置

4、配置静态资源

<mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/"/>
<mvc:resources mapping="/webjars/**" location="classpath:/META-INF/resources/webjars/"/>

5、配置web.xml

<servlet>
<description>spring mvc servlet</description>
<servlet-name>springMvc</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring-mvc.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>springMvc</servlet-name>
<url-pattern>*.shtml</url-pattern>
<url-pattern>/swagger-resources</url-pattern>
<url-pattern>/swagger-resources/configuration/ui</url-pattern>
<url-pattern>/swagger-resources/configuration/security</url-pattern>
<url-pattern>/v2/api-docs</url-pattern>
</servlet-mapping>