SpringBoot之Swagger使用

标签： Springboot 分类： Java 创建时间：2020-07-21 01:01:48 更新时间：2025-01-17 10:39:22

我只是一个没有感情的代码搬运工罢了。

Swagger其实是一个很简单工具，只要轻松的配置一下，就可以了。在配置的时候，还是要注意安全性的问题。

1.加入依赖

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

2.配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
}

3.验证

打开浏览器的地址：http://localhost/v2/api-docs,这里的端口号，和你在application.yml中配置的是一样的，我这里配置了80端口。

参考文章：
1.swagger使用总结
2.spring-boot-starter-swagger (借助于spring-boot的无注解的方式，进行了优化工具)
3.Swagger使用指南
4.在 Spring Boot 项目中使用 Swagger 文档 (这篇文章，照着做就好了)
5.配置不同环境下启用swagger，在生产环境关闭swagger (关于如何在生产环境下，以及非生产环境下进行Swagger配置)
6.配置不同环境下启用swagger，在生产环境关闭swagger (和上面的一样)

4.添加ui

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

问题

参考文章中的例子和我的很相似，也是因为我重新了springboot的自动装配模式，所以导致了没有静态资源的映射。像下面的1、2、3文章，都是说的是swagger2.x的情况，但是我的使用的是3.0.0的情况，根本不符合我的要求，起码swagger-ui.html已经不存在了。

当我使用了：http://localhost/webjars/springfox-swagger-ui/index.html 页面，虽然打开了ui，但是页面报错了。

我换成了springfox-swagger-ui 2.9.2,访问：http://localhost/swagger-ui.html,是可以使用的，于是继续的探索。

经过多方尝试，还是不行的。看来3.0.0还是有问题，于是我换回了2.9.2。

然后配置web

@Configuration
public class WebMvcCon implements WebMvcConfigurer  {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        registry.addResourceHandler("/static/**").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/");
    }
}

参考文章：
1.Swagger-ui.html界面打开报404错误 (这个除了有解决问题的方法之外，还写了原因的发现过程)
2.解决SpringBoot2.0集成Swagger2访问404的问题
3.SpringBoot配置SwaggerConfig后，访问404错误 (使用这个可以解决问题)
4.Cannot read property ‘1’ of undefined (Swagger Hub) (这是3.0.0报错)
5.v3 - Resolver error - Cannot read property ‘1’ of undefined
6.Getting HTTP 404 error on /swagger-ui.html but other swagger endpoint works
7.404 when for snapshot version of springfox-swagger-ui 3.0.0-SNAPSHOT (这里也有人说了好像swagger-ui3.0.0不能用)

往期推荐

文章目录

微信公众号

广告位

诚心邀请广大金主爸爸洽谈合作

每日一省

isNaN 和 Number.isNaN 函数的区别？

1.函数 isNaN 接收参数后，会尝试将这个参数转换为数值，任何不能被转换为数值的的值都会返回 true，因此非数字值传入也会返回 true ，会影响 NaN 的判断。

2.函数 Number.isNaN 会首先判断传入参数是否为数字，如果是数字再继续判断是否为 NaN ，不会进行数据类型的转换，这种方法对于 NaN 的判断更为准确。

每日二省

为什么0.1+0.2 ! == 0.3，如何让其相等?

一个直接的解决方法就是设置一个误差范围，通常称为“机器精度”。对JavaScript来说，这个值通常为2-52，在ES6中，提供了Number.EPSILON属性，而它的值就是2-52，只要判断0.1+0.2-0.3是否小于Number.EPSILON，如果小于，就可以判断为0.1+0.2 ===0.3。

每日三省

== 操作符的强制类型转换规则？

1.首先会判断两者类型是否**相同，**相同的话就比较两者的大小。

2.类型不相同的话，就会进行类型转换。

3.会先判断是否在对比 null 和 undefined，是的话就会返回 true。

4.判断两者类型是否为 string 和 number，是的话就会将字符串转换为 number。

5.判断其中一方是否为 boolean，是的话就会把 boolean 转为 number 再进行判断。

6.判断其中一方是否为 object 且另一方为 string、number 或者 symbol，是的话就会把 object 转为原始类型再进行判断。

每日英语

Happiness is time precipitation, smile is the lonely sad.

幸福是年华的沉淀，微笑是寂寞的悲伤。