栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

Spring Boot 整合 Swagger 3.0

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

Spring Boot 整合 Swagger 3.0

 特别注意
  1. 增加注解@EnableOpenApi 而不要使用注解@EnableSwagger2

  2. 启动项目,访问地址:http://localhost:8080/swagger-ui/index.html,(注意swagger2.x版本中访问的地址的为http://localhost:8080/swagger-ui.html)

  3. 如果配置了Spring Security 则需要配置白名单策略 以及 token策略

整合

​​ 流程概述

  1. pom.xml 导入 jar包
  2. SwaggerConfig.java
  3. SecurityConfig.java [可选]
  4. 访问地址
  5. 配置token [可选]
1. pom.xml 导入 jar包

​​ pom.xml


    io.springfox
    springfox-boot-starter
    3.0.0

2. SwaggerConfig.java

​ SwaggerConfig.java

@Configuration
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                .select()
                //为当前包下controller生成API文档
                .apis(RequestHandlerSelectors.basePackage("cn.dearth.controller"))
                //为有@Api注解的Controller生成API文档
//                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                //为有@ApiOperation注解的方法生成API文档
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerUI演示")
                .description("test")
                .version("1.0.0")
                .build();
    }
}
3. SecurityConfig.java [可选]

​​ SecurityConfig.java

项目中加了Spring Security的可以参照以下配置

@Configuration
@EnableWebSecurity
@RequiredArgsConstructor
public class SecurityConfig extends WebSecurityConfigurerAdapter {

	//
	@Override
    public void configure(WebSecurity web) throws Exception {
        web.ignoring().antMatchers("/swagger**/
}
4. 访问地址

http://localhost:8080/swagger-ui/index.html

5. 配置token
@Configuration
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo()).enable(true)
                .securityContexts(Collections.singletonList(securityContext())) 
                .securitySchemes(Collections.singletonList(apiKey()))
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.dearth.vex.controller"))
                .paths(PathSelectors.any())
                .build();
    }

	//********************************** begin ************************************************
    private SecurityContext securityContext() {
        return SecurityContext.builder().securityReferences(defaultAuth()).build();
    }

    private List defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Collections.singletonList(new SecurityReference("Authorization", authorizationScopes));
    }

    private ApiKey apiKey() {
        return new ApiKey("Authorization", "Authorization", "header");
    }

	//********************************** end ************************************************


    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SwaggerUI演示")
                .description("test")
                .version("1.0.0")
                .build();
    }

}
转载请注明:文章转载自 www.mshxw.com
本文地址:https://www.mshxw.com/it/978438.html
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号