Springboot整合Swagger2问题记录

最新推荐文章于 2024-07-29 10:09:42 发布

故渊池鱼

最新推荐文章于 2024-07-29 10:09:42 发布

阅读量1.2k

点赞数 2

分类专栏： Java 文章标签： swagger NumberFormat csrf 404 springboot

本文为博主原创文章，转载请声明出处。

本文链接：https://blog.csdn.net/zuoyixiao/article/details/105483529

版权

Java 专栏收录该内容

31 篇文章 1 订阅

订阅专栏

在Springboot整合Swagger2的过程中，遇到的一些问题记录。

环境信息：

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
</parent>

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

问题1：使用shiro管理权限试，访问swagger页面被拦截，无权限访问等

解决：需要在shiro中放行swagger的请求。

filterChainDefinitionMap.put("/swagger/**", "anon");
filterChainDefinitionMap.put("/swagger-ui.html", "anon");
filterChainDefinitionMap.put("/swagger-resources/**", "anon");
filterChainDefinitionMap.put("/v2/api-docs", "anon");
filterChainDefinitionMap.put("/webjars/**", "anon");
filterChainDefinitionMap.put("/doc.html", "anon");

问题2：@ApiModelProperty 中无 example 会报 NumberFormatException 的异常

(io.swagger.models.parameters.AbstractSerializableParameter.getExample:421) - Illegal DefaultValue null for parameter type integer
java.lang.NumberFormatException: For input string: ""

解决：增加老版本annotations和models的依赖。

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.6.1</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.6.1</version>
</dependency>

问题3：使用jwt的token机制时，前端会报 / csrf 404 的问题

解决：这个问题在 2.9.x 版本中有(https://github.com/springfox/springfox/issues/2603) ，暂时还没有找到好的解决方案，回退到 2.8.0 版本。

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