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

springboot整合swagger

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

springboot整合swagger

1.导入依赖

    io.springfox
    springfox-swagger2
    2.9.2



    io.springfox
    springfox-swagger-ui
    2.9.2

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 globalOperation(){
        //添加head参数配置start
        ParameterBuilder tokenPar = new ParameterBuilder();
        List 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 security() {
        return com.google.common.collect.Lists.newArrayList(
                new ApiKey("token", "token", "header")
        );
    }
}
3.访问

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

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

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

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