springboot整合swagger

1.导入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

2.SwaggerConfig配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.ApiKey;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                //1。文档信息
                .apiInfo(apiInfo())
                //2.扫描信息
                .select()
//                .apis(RequestHandlerSelectors.basePackage("com.monkey.controller")) //1.指定包扫描
//                .apis(RequestHandlerSelectors.any())                                //2.扫描全部
//                .apis(RequestHandlerSelectors.none())                               //3.都不扫描
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))//4.扫描注解(常用)                               //都不扫描
//                .paths(PathSelectors.ant("/hello/**"))                      //过滤
                .build()
                //3.是否启用swagger(默认开启)
                .enable(true)
                //4.分组(配置多个Docket,就有多个分组)
                .groupName("monkey")
                //5.配置token
                .globalOperationParameters(globalOperation());       // 1.主要关注点----每个接口调用都填写token
//                .securitySchemes(security());                           //2.全局配置token

    }

    //配置界面用户信息
    public ApiInfo apiInfo(){
        Contact contact = new Contact("monkey", "", "1652553558@qq.com");//邮箱信息
        return new ApiInfo(
                "Swagger Api接口文档",  //标题
                "Api Documentation",    //描述
                "V1.0", //版本
                "urn:tos", contact, //邮箱
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList());
    }
    
    //1.配置token表头(每个接口都配置)
    private List<Parameter> globalOperation(){
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List<Parameter> pars = new ArrayList<>();
        //第一个token为传参的key,第二个token为swagger页面显示的值
        tokenPar.name("token").description("token").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
        pars.add(tokenPar.build());

        return pars;
    }
    //2.配置token表头(全局配置)
    private List<ApiKey> security() {
        return com.google.common.collect.Lists.newArrayList(
                new ApiKey("token", "token", "header")
        );
    }
}

3.访问

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

在这里插入图片描述

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值