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

springboot-swagger配置以及我的报错(贼详细)

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

springboot-swagger配置以及我的报错(贼详细)

Swagger使用 导入依赖


    io.springfox
    springfox-swagger2
    3.0.0



    io.springfox
    springfox-swagger-ui
    3.0.0



    io.springfox
    springfox-boot-starter
    3.0.0



    org.springframework.boot
    spring-boot-starter-parent
    2.5.6
     


Swagger装配
import org.springframework.context.annotation.Configuration;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration //加入配置
@EnableSwagger2//开启swagger
@EnableOpenApi //开启api
public class SwaggerConfig {


}

SwaggerAPI页面访问 注意点
  • 因为装配的Swagger是3.0.0的版本,所以访问的网页有了变化
    网页地址为:http://localhost:8080/swagger-ui/index.html
  • 如果是3.0.0以下版本
    网页地址为:http://localhost:8080/swagger-ui.html
配置Swagger信息 重写,代替默认的Swagger实例 Docket。

CTRL点击Docket,发现需要一个文本类型类。

CTRL点击DocumentationType,探究这个玩意

发现有个SWAGGER_2的静态最终类,可以点出来。
又发现Docket还有一个ApiInfo的属性,它可以指定一些信息。
基本配置如下:

@Configuration
@EnableSwagger2
@EnableOpenApi
public class SwaggerConfig {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
        		.apiInfo(apiInfo())
                .select()
                //配置自动扫描包获取接口
   			    .apis(RequestHandlerSelectors.basePackage("com.zhuli.controller"))
                .build();
    }

    public ApiInfo apiInfo(){
        return new ApiInfo(
                "my lover is zyp",
                "zhuli",
                "1.1",
                "urn:tos",
                new Contact("朱溧", "江苏省泰州市", "2122332078@qq.com"),
                "zhuli 2.0",
                "阿巴阿巴",
                new ArrayList<>()//这个地方我也不晓得啥东西
                );

    }

}
比较

原先swagger的网页:

配置后:

这里的groupname可以指定组名

当有多个开发人员时,可以装配多个Docket。
对于不同环境是否需要swagger在下面也有显示。
别用错包

package com.zhuli.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.oas.annotations.EnableOpenApi;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import java.util.*;
@Configuration
@EnableSwagger2
@EnableOpenApi
public class SwaggerConfig {
    @Bean
    public Docket docket(Environment environment){
        //环境名是否在of参数里
        Profiles dev = Profiles.of("dev");
        boolean b = environment.acceptsProfiles(dev);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(b)//判断环境是否开启swagger
                .groupName("朱溧") //分组组名
                .select()
                //配置自动扫描包获取接口
                .apis(RequestHandlerSelectors.basePackage("com.zhuli.controller"))
                .build();
    }

    public ApiInfo apiInfo(){
        return new ApiInfo(
                "my lover is zyp",
                "zhuli",
                "1.1",
                "urn:tos",
                new Contact("朱溧", "江苏省泰州市", "2122332078@qq.com"),
                "zhuli 2.0",
                "阿巴阿巴",
                new ArrayList<>()//这个地方我也不晓得啥东西
                );

    }

}

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

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

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