首页 > 其他分享 >swagger3 配置

swagger3 配置

时间:2022-08-27 14:55:33浏览次数:68  
标签:配置 documentation springframework swagger3 org import springfox annotation

在pom.xml添加swagger3.0的依赖:

<dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-boot-starter</artifactId>
       <version>3.0.0</version>
</dependency>

创建SwaggerConfig 配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
@EnableWebMvc
public class SwaggerConfig extends WebMvcConfigurationSupport {

    @Bean
    public Docket docketCategory() {
        return new Docket(DocumentationType.OAS_30)
                .apiInfo(apiInfo())
                // 分组名称
                .groupName("default")
                //使能swagger
                .enable(true)
                .select()
                //设置接口包名
                .apis(RequestHandlerSelectors.basePackage("com.example.controler"))
                //设置请求路径开头的接口
                .paths(PathSelectors.ant("/files/**"))
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("接口总览")
                .description("测试")
                .version("1.0")
                .build();
    }
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决静态资源无法访问
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }

}

 访问:http://localhost:8080/swagger-ui/index.html

标签:配置,documentation,springframework,swagger3,org,import,springfox,annotation
From: https://www.cnblogs.com/cokelike/p/16630355.html

相关文章

  • 阿波罗配置中心部署
    安装mysql可以使用dockerdockerpullmysql:latestdockerrun-itd--namemysql-test-p3306:3306-eMYSQL_ROOT_PASSWORD=123456mysql//进入容器dockerexec......
  • 单机版zookeeper的安装与配置
    准备工作,安装JDK:https://www.cnblogs.com/javasl/p/11154205.html1、解压文件到指定目录tar-zxfzookeeper-3.4.6.tar.gz-C/usr/local/myroom2、配置环境变量,将下......
  • Nginx分布式框架详解-基础32-36nginx基础配置实例
    nginx基础配置实例需求分析前面我们已经对Nginx服务器默认配置文件的结构和涉及的基本指令做了详细的阐述。通过这些指令的合理配置,我们就可以让一台Nginx服务器正常......
  • self4j 微服务日志配置-按微服务应用分别生成不同的日志文件
    如题:效果是:在/opt/myApps/logs/app1/app1.log/opt/myApps/logs/app2/app2.log每个应用独立存储日志;<?xmlversion="1.0"encoding="UTF-8"?><configuration><spr......
  • STM32环境配置
    ==================================STM32概念==================================一、什么叫STM32 ST:意法半导体 M:ARM公司的cortex-M内核 32:32位单片机 STM32:ST公司......
  • Nginx分布式框架详解-基础22-31nginx核心配置文件
    nginx配置文件nginx.conf的文件结构从前面的内容学习中,我们知道Nginx的核心配置文件默认是放在/usr/local/nginx/conf/nginx.conf,本次我们就来学习下nginx.conf的内......
  • IDEA的模板及配置
    什么是模板什么是模板?简单的理解就是配置一些字母缩写。使用简写的方式,就能出现预定义的固定代码。这样做可以大大提高开发效率。最常见的就是输入 sout就会出现 Syst......
  • Shopify Spark主题模板配置修改
    对于那些正在启动业务的shopify卖家来说,Spark主题是很好的选择,它跨越了你的愿景和市场之间的差距,将美感和必要性结合在一起,这样你就可以用最小的触角将事情进行下去。通过......
  • Debian 11 安装配置 tomcat 10.0.23
    阿里云轻量级服务器Debian11安装配置tomcat-10.0.23一、从官网下载tomcat10.0.23sudowgethttps://dlcdn.apache.org/tomcat/tomcat-10/v10.0.23/bin/apache-tomca......
  • Flask 学习-19.配置管理flask_sqlalchemy 和 flask_migrate
    前言前面讲了项目中使用config.py可以管理开发、生产、测试等环境的配置,这篇继续学习在项目中添加flask_sqlalchemy和flask_migrate的配置环境准备先pip安装flask_s......