springboot 集成 swagger生成在线文档

1、引入POM依赖

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>

        <!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

2、编写swagger的配置类

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

/**
 * @auther :
 * @description :
 * @email :
 * @date : 2017-12-6
 */
@Slf4j
@Configuration
@EnableSwagger2 // 启用 Swagger
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.zeus.thor.controller"))//controller所在的文件夹
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        .title("利用swagger构建api文档")
        .description("简单优雅的rest风格")
        .termsOfServiceUrl("http://www.baidu.com")
        .version("1.0")
        .build();
    }
}

3、编写测试类

import com.zeus.thor.common.Path;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;

/**
 * @auther : 
 * @description :
 * @email : 
 * @date : 2017-12-6
 */
@Slf4j
@RestController
@RequestMapping(Path.ROOT)
public class DemoController {


    @ApiOperation(value="测试", notes="测试案例")
    @ResponseBody
    @GetMapping(value = "testDemo")
    public String testDemo( @ApiParam(required=true, name="msg",value="消息内容") @RequestParam(name = "msg")String msg){
        return msg;
    }
}

4、查看页面效果

打开连接http://localhost:8080/swagger-ui.html

PS：关于生产环境中必须禁用swagger以免泄露接口信息，笔者的建议的是通过nginx去禁用 http://xxxxxx.com/swagger-ui.html该地址。