springBoot 项目配置swagger2

第一步 在pom.xml 文件中添加依赖

    
        io.springfox
        springfox-swagger2
        2.7.0
    
    
        io.springfox
        springfox-swagger-ui
        2.7.0
    
    
    版本根据自己的实际需要可能不同

第二步 在 config 文件夹下面创建配置类我们取名为SwaggerConfig 代码如下

@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("*******.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title(“测试API”)
.description(“测试接口说明”)
.version(“1.0”)
.build();
}

}
说明：.basePackage 中填写你的controller 所在的文件夹的位置坳

第三步 在springboot 配置文件中添加配置我这里使用的是.yml 文件 （注意层级关系）
spring：
swagger2:
enable: true

第四步 在controller 中 类名称上面引入注解@Api(description=“填写自己需要的名字”)

方法名称上引入下面注解
@ApiOperation(value = “接口名称”, notes = “接口名称方法”)
@ApiImplicitParams({
@ApiImplicitParam(paramType=“query”, name = “index”, value = “排序”, required = true, dataType = “String”),
@ApiImplicitParam(paramType=“query”, name = “page”, value = “页码”, required = true, dataType = “Integer”),
@ApiImplicitParam(paramType=“query”, name = “size”, value = “条数”, required = true, dataType = “Integer”),
})
注意：请求方式 推荐你写清楚是post 还是 get 要是你这里写的是RequestMapping 你可以自己看看效果

第五步 在你的启动类方法名称上面引入@EnableSwagger2 启动成功后就可以访问 啦，例:我的启动端口是80 那么我直接在浏览器中输入http://localhost:80/swagger-ui.html 就ok 啦