【架构师成长之路】4-零基础搭建单体项目-集成swagger

4.集成swagger

首先引入依赖

<!--swagger增强文档-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>${knife4j.version}</version>
        </dependency>

新建SwaggerConfig.java 配置类

package com.chase.frame.config;

import org.springframework.beans.factory.annotation.Value;
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.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.ArrayList;
import java.util.List;


/**
 * @author chase
 * @Desc
 * @date 2022/2/8 10:01
 */
@Configuration
@EnableSwagger2WebMvc
public class SwaggerConfig {

    @Value("${swagger.enabled}")
    private Boolean enabled;

    private static ApiInfo apiInfo;
    private static List<SecurityContext> securityContextList;
    private static List<SecurityReference> securityReferenceList;
    private static List<SecurityScheme> securitySchemeList;

    static {
        apiInfo = new ApiInfoBuilder()
                .title("demo系统")
                .contact(new Contact("yy", "http://www.yy.com", "yy@yy.com"))
                .description("demo系统接口文档")
                .version("1.0.0")
                .build();

        securityReferenceList = new ArrayList<>();
        AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
        AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
        authorizationScopes[0] = authorizationScope;
        securityReferenceList.add(new SecurityReference("token", authorizationScopes));

        securityContextList = new ArrayList<>();
        securityContextList.add(
                SecurityContext.builder()
                        .securityReferences(securityReferenceList)
                        .forPaths(PathSelectors.regex("^(?!auth).*$"))
                        .build());

        securitySchemeList = new ArrayList<>();
        securitySchemeList.add(new ApiKey("token", "token", "header"));
    }

    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("manage")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.chase.frame.controller"))
                .build()
                .securitySchemes(securitySchemeList)
                .securityContexts(securityContextList)
                .enable(true);
    }

   /* @Bean
    public Docket docket1() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("app")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yy.youbimanage.controller.web"))
                .build()
                .securitySchemes(securitySchemeList)
                .securityContexts(securityContextList)
                .enable(true);
    }*/
}

yml配置swagger开启开关
在这里插入图片描述

路由拦截过滤接口文档的请求地址
在这里插入图片描述

输入域名:端口/doc.html
在这里插入图片描述
集成成功

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值