Press "Enter" to skip to content

Spring Boot 集成 Swagger

1.Gradle配置

build.gradle增加Swagger依赖

compile 'io.springfox:springfox-swagger2:2.7.0'
compile 'io.springfox:springfox-swagger-ui:2.7.0'

Swagger配置

im.mango.app下新建conf文件夹

config下新建SwaggerConfig

package im.mango.app.conf;

// 省略import

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

在上一篇中已经做了一个简单的Get User信息的接口。

重启应用,访问 http://localhost:8080/v2/api-docs 可以看到Swagger接口文档

视图界面: http://localhost:8080/swagger-ui.html

这时基本搭建已经完成了,不过细心的你会发现有个basic-error-controller接口文档,怎么去掉呢?

你可以将请求处理程序选择器限制为仅扫描项目的程序包。

return new Docket( DocumentationType.SWAGGER_2)
        .select()
        .apis( RequestHandlerSelectors.basePackage( "your package" ) )
        ...

比如我这里改成im.mango.app就可以了。

Be First to Comment

发表评论

电子邮件地址不会被公开。 必填项已用*标注