springboot 整合 swagger2

引入依赖包

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

创建配置启动类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                //扫描的路径包
                .apis(RequestHandlerSelectors.basePackage("com.*****.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //设置文档标题(API名称)
                .title("接口规范")
        //文档描述
                .description("")
        //服务条款URL
                .termsOfServiceUrl("http://localhost:8082/webjars/springfox-swagger-ui/index.html")
        //版本号
                .version("1.0.0")
                .build();
    }
}

在接口上增加swagger注解

基本注解：
@Api 描述类/接口的主要用途
@ApiOperation 描述方法用途
@ApiImplicitParam 描述方法的参数
@ApiImplicitParams 描述方法的参数(Multi-Params)
@ApiIgnore 忽略某类/方法/参数的文档
示例：

@RestController
@RequestMapping("/swagger-test")
@Api(value = "测试接口", tags = "测试swagger相关的接口", description= "测试接口")
public class TestController {
    @RequestMapping(value = "/test", method = RequestMethod.POST)
    @ApiImplicitParam(name = "map", value = "测试接口")
    @ApiOperation(value = "测试接口1111", notes = "测试接口")
    public void test(@RequestBody Map<String, Long> map){
       
    }
}

查看接口文档

登录地址：http://localhost:8080/swagger-ui.html