在 spring mvc 中使用 swagger2

第一步:配置 prom.xml 文件

<!-- swagger-springmvc -->        <dependency>            <groupId>io.springfox</groupId>            <artifactId>springfox-swagger2</artifactId>            <version>2.5.0</version>        </dependency>        <dependency>            <groupId>io.springfox</groupId>            <artifactId>springfox-swagger-ui</artifactId>            <version>2.5.0</version>        </dependency>        <!-- swagger-springmvc dependencies -->

第二部配置: spring-mvc.xml 文件

<mvc:annotation-driven />    <!-- enable autowire 向容器自动注册 -->    <context:annotation-config />    <!-- 自动扫描该包，使SpringMVC认为包下用了@controller注解的类是控制器 -->    <context:component-scan base-package="cn.com.xxxxx.controller" />    <!-- 使用 Swagger Restful API文档时，添加此注解 -->      <mvc:default-servlet-handler />    <!-- swagge 访问路径 -->    <mvc:resources mapping="swagger-ui.html" location="classpath:/META-INF/resources/" />    <mvc:resources mapping="/webjars/**"        location="classpath:/META-INF/resources/webjars/" />

第三部创建SwaggerConfig.class

package cn.com.biyouxiu.tools;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import org.springframework.web.servlet.config.annotation.EnableWebMvc;import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;import io.swagger.annotations.ApiOperation;import io.swagger.annotations.ApiParam;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;/** * @author lpf * @version v1.0：2017年8月8日 上午10:10:06  * swagger配置文件 */@EnableWebMvc  @EnableSwagger2  @Configurationpublic class SwaggerConfig extends WebMvcConfigurationSupport{    @Bean    public Docket api() {        return new Docket(DocumentationType.SWAGGER_2)                .select()                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))                .build()                .apiInfo(apiInfo());    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("biyouxiu对外开放平台")                .description("HTTP对外开放接口")                .version("1.0.0")                .termsOfServiceUrl("http://xxx.xxx.com")                .license("所有学生端非注册操作都需要 token否则非法")                .licenseUrl("http://xxx.xxx.com")                .build();    }}

第四部:对 controller 进行注释

@RequestMapping(value = "showCourseList", method = RequestMethod.GET)    @ResponseBody    @ApiOperation(value="获取课程首页信息",httpMethod="GET")    public Map<String, java.lang.Object> getCourseList(@ApiParam(value="token",required=true)HttpServletRequest request) {        return courseService.getCourseList((String) request.getAttribute("userId"));    }

第五步:访问 localhost:8080//项目名/swagger-ui.html
大功告成