spring boot 开启 swagger2 (IntelliJ IDEA)

最新推荐文章于 2024-09-13 22:23:10 发布

weixin_34200628

最新推荐文章于 2024-09-13 22:23:10 发布

阅读量282

点赞数

文章标签：开发工具 java python

原文链接：https://my.oschina.net/oldfeel/blog/844005

版权

2019独角兽企业重金招聘Python工程师标准>>>

添加 dependencies

    compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.6.1'
    compile group: 'io.springfox', name: 'springfox-swagger-ui', version: '2.6.1'

添加 SwaggerConfig.java

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

打开项目地址+swagger-ui.html即可,例如

http://localhost:8017/swagger-ui.html

如果要设置指定 package 下的 controller 和自定义 apiInfo.则需要修改 SwaggerConfig.java

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yuncommunity.guqin.controller"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo());
    }

    private ApiInfo apiInfo() {
        return new ApiInfo("中国古琴", "接口文档", "1.0", "termsOfServiceUrl", new Contact("oldfeel", "http://yuncommunity.com", "hyt5926@163.com"), "license", "licenseUrl");
    }
}

转载于:https://my.oschina.net/oldfeel/blog/844005