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

spring-boot配置swagger2

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

spring-boot配置swagger2

1. 导入jar包(引入pom.xml文件包)

注意:swagger2 需要 jdk1.8以上才可运行

   
        
        
            io.springfox
            springfox-swagger2
            2.8.0
        

        
            io.springfox
            springfox-swagger-ui
            2.8.0
        
  
2. 编写swaggerConfig配置类
package cc.test.zdq.common.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.AuthorizationScope;
import springfox.documentation.service.SecurityReference;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.Arrays;
import java.util.List;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot 集成 Swagger2 构建RESTful API")
                .description("wx")
                .version("2.8.0")
                .description("test API")
                .build();
    }
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(true)
                .select()
                //导入依赖的package包/类
                .apis(RequestHandlerSelectors.basePackage("cc.test.zdq"))
                .paths(PathSelectors.any())
                .build()
                //配置token令牌验证
                .securitySchemes(securitySchemes())
                .securityContexts(securityContexts());
                //.globalOperationParameters(pars);
    }

    private List securityContexts() {
        return Arrays.asList(SecurityContext.builder()
                .securityReferences(defaultAuth())
                .forPaths(PathSelectors.any())
                .build());

    }

    private List securitySchemes() {
    	//Authentication: 需要换成自己的身份验证标头
        return Arrays.asList(new ApiKey("Authentication", "Authentication", "header"));
    }
    List defaultAuth() {
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        return Arrays.asList(new SecurityReference("Authentication", authorizationScopes));
    }
}
启动项目后在浏览器输入:http://ip:port/swagger-ui.html

如图:

至此 swagger2 的配置就完成了

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

版权所有 (c)2021-2022 wk8.com.cn

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