记录一个swagger的坑

最新推荐文章于 2024-07-04 19:04:24 发布
最新推荐文章于 2024-07-04 19:04:24 发布
阅读量134 收藏
点赞数
分类专栏： 错误日志 文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_41277823/article/details/129120388
版权
  • List item
    springboot项目添加swagger，配置完成后，访问swagger页面出现
    unable to infer base url .this is common when using dynamic servlet regisrat.
    如图：
    swagger访问报错
    经过一番百度，各种尝试之后，找到了原因：
    代码中使用**@ControllerAdvice（或@RestControllerAdvice）**了对返回结果的统一封装（json格式化），导致返回的json格式和swagger要求的结果不同，所以swagger一直报错。

解决办法：指定该注解的包扫描路径，让它只扫描controller包。
在这里插入图片描述

天锁_szw
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
swagger2避坑记录
xu123_chao的博客
01-05 278
swagger2避坑记录
springMVC + Swagger2神坑记录
chris_chenhong的博客
05-22 307
项目框架是SSM的，因为要重构成前后端分离的形式，为了省点力气写文档，引入Swagger2来自动生成文档，在网上找了一堆教程，解决了后端配置问题，没想到卡在了页面获取接口数据上。 SpringMVC框架要自己加入swaggerui前端文件，在swagger页面载入时需要配置文档数据获取接口，官方文档给到的是 <script> window.onload = function() { // Begin Swagger UI call region const ui
spring boot定义全局返回值导致swagger无法访问
u014723730的博客
06-01 694
在 supports() 方法中，我们判断当前请求是否是 Swagger 相关的请求，如果是则返回 false，否则返回 true；在 beforeBodyWrite() 方法中，我们同样通过判断请求的 URI Path 是否以 “/swagger” 或 “/v2/api-docs” 开头的方式，来判断当前请求是否是 Swagger 相关的请求。如果是，则直接返回原始的响应体；具体来说，可以在处理返回值的方法中，判断当前请求是否是 Swagger 相关的请求，如果是，则不进行缓存操作。
Swagger一直显示basic-error-controller
qq_39452315的博客
08-09 2504
表示swagger会把加了@ ApiOperation的方法扫描进去。
Swagger配置问题（版本不兼容）
最新发布
lzzz6262的博客
07-04 824
Docket docket = new Docket(DocumentationType.SWAGGER_2) .groupName("接口") .apiInfo(apiInfo) .select() .apis(RequestHandlerSelectors.basePackage("com.house.controller")) .paths(PathSelectors.any()) .build();升级swagger不行，直接将spring版本呗，我就降到了spring2.5，成功运行。
Swagger弹窗报错：Unable to infer base url.
sushiyi651的博客
03-08 1483
springboot集成swagger，所有配置都配置好之后，访问：http://localhost:8080/swagger-ui/ 出现弹窗报错如下图： 2、未加@EnableSwagger2配置。3、项目中使用了全局统一处理类即@ControllerAdvice或ResponseBodyAdvice，会导致接口返回JSON数据格式和swagger期望的不一样，造成swagger报错。 解决方法很简单，在代码上加上你自己扫描包的范围，因为@ControllerAdvice主要是拦截controlle
配置Swagger2控制台报错空指针，访问弹窗口Unable to infer base url. This is common when using dynamic servlet
CSDN_429的博客
05-29 1478
我的SpringBoot版本是2.7的，Swageer是2.9.0 这个错误在网上看了一大堆，都没有解决，后面自己搜了好久才找到解决方案，一般大家都是看到第三种的解决方式，然后出现了控制台报错，控制台报错在appliction中加配置 下面是几个可能出现的问题，下面给大家总结下 一、没有导入依赖 二，看看config配置里面有没有加上注解 三、在启动类加上注解 ！！注意~~~~ 如果第三步加上之后发现控制台报了空指针的错误，不急，把第四步代码加上就可以解决了，...
Zuul中聚合Swagger的坑
u010889990的专栏
05-01 2238
每个服务都有自己的接口，通过Swagger来管理接口文档。在服务较多的时候我们希望有一个统一的入口来进行文档的查看，这个时候可以在zuul中进行文档的聚合显示。 下面来看下具体的整合步骤以及采坑记录。Cloud版本：Finchley.SR2， Boot版本：2.0.6 加入Swagger的依赖： <!-- Swagger --> <dependency> <grou...
swagger2使用踩过的坑
曰业而安的博客
06-11 2827
在项目中使用swagger2生成API确实为程序员带来了很多福音，但是在使用过程中，可能会遇到这样那样的坑，网上关于swagger2的介绍也有很多，本篇记录个人在使用过程中踩过的坑，高手可以忽略。 1.访问swagger的首页swagger-ui.html 时报错404。 本地访问时，查看swagger的配置是否被扫描到，以及使用的swagger注解是否正确完善。 2.能访问首页但是不出接口 要查看扫描包的路径有没有错误。 3. Couldnotresolvereference...
Swagger环境搭建
Jack汪喆的技术分享栏
04-13 585
什么是Swagger？ Swagger是一款RESTFUL接口的文档在线自动生成+功能测试工具，专门用于生成/描述/调用和可视化RESTFUL风格的Web服务 一.依赖引入与环境构建 1.引入依赖 引入springfox-swagger2依赖compile group: 'io.springfox', name: 'springfox-swagger2', version: '2.9.2'...
springboot处理全局异常注释@RestControllerAdvice
weixin_42471170的博客
06-02 286
1.编写全局异常处理类，在类前面加上注释@RestControllerAdvice，结合@ExceptionHandler一起处理各种对应的异常并返回异常的结果。如下： package com.lz.hehuorenservice.common.exception; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestContr
SpringBoot使用Swagger2出现Unable to infer base url.
裸睡的鱼
04-22 7655
SpringBoot使用Swagger2出现Unable to infer base url. 在使用SpringBoot中配置Swagger2的时候，出现 Unable to infer base url. This is common when using dynamic servlet registration or when the API is behind an API Gatew...
注解@RestControllerAdvice和@ControllerAdvice的使用区别
oliver1988的专栏
09-09 6567
一般作用于含有注解@RestController的Controller层，对@RequestMapping注解的方法起作用。 @RestControllerAdvice和@ControllerAdvice， 1）都在org.springframework.web.bind.annotation包下面; 2）都用于注解类( => @Target(ElementType....
Spring @ControllerAdvice与@RestControllerAdvice注解
热门推荐
fang_qiming的博客
04-12 3万+
@ControllerAdvice是组件注解，他使得其实现类能够被classpath扫描自动发现，如果应用是通过MVC命令空间或MVC Java编程方式配置，那么该特性默认是自动开启的。注解@ControllerAdvice的类可以拥有@ExceptionHandler, @InitBinder或 @ModelAttribute注解的方法，并且这些方法会被应用到控制器类层次的所有@RequestM...
Spring MVC中@ControllerAdvice注解实现全局异常拦截
smile_lg的博客
03-27 3448
@ControllerAdvice注解一般用作处理系统error，拦截出错信息，返回报错提示界面，防止用户看到一推出错信息！ Java代码  import org.springframework.ui.Model;  import org.springframework.web.bind.WebDataBinder;  import org.springframework.web.bind.ann...
使用@ControllerAdvice实现全局异常处理
qq_45752401的博客
07-28 1680
1，定义统一返回封装类 /** * 返回结果通用封装 */ @Data //给set方法设置返回对象，返回对象就是自己本身 @Accessors(chain = true) //使对象可以使用builder方式进行创建 @Builder @ApiModel(value = "Result对象",description = "通用结果返回对象") public class Result<T> implements Serializable { private static final
SpringBoot项目基于@RestControllerAdvice注解进行全局异常统一处理
CHQIUU的专栏
09-01 1万+
当我们在使用SpringBoot开发项目时，通常会对异常进行全局统一处理。在SpringBoot项目中，要进行全局异常处理通常有3种方式： 通过@RestControllerAdvice或@ControllerAdvice注解方式； 通过AOP切面方式； 通过继承ErrorController方式； 通过权衡，这里我们还是采用注解方式，减少代码耦合度，项目开上去也比较清爽。 创建GlobalExceptionHandler类并添加注解@RestControllerAdvice，具体代码如下所示。当然你也
@RestControllerAdvice（@ControllerAdvice）拦截异常统一处理
judicator0301的博客
07-28 3054
@ControllerAdvice文档 spring 3.2中，新增了@ControllerAdvice 注解，用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。 如果全部异常处理返回json，那么可以使用 @RestControllerAdvice 代替 @ControllerAdvice ，这样在方法上就可以不需要添加 @ResponseBody。 当不做任何处理时，默认的异常返回格式： { "tim
生成一个Swagger的实体类和controller
06-08
好的，生成Swagger的实体类和controller的过程如下： 1. 首先需要在项目的pom.xml文件中添加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> ``` 2. 在Spring Boot的启动类上添加@EnableSwagger2注解，启用Swagger： ``` @SpringBootApplication @EnableSwagger2 public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 3. 创建实体类，并使用Swagger的注解来描述实体类： ``` @ApiModel(description = "用户信息") public class User { @ApiModelProperty(value = "用户ID", example = "1") private Long id; @ApiModelProperty(value = "用户名", example = "张三") private String name; @ApiModelProperty(value = "年龄", example = "18") private Integer age; // 省略getter和setter方法 } ``` 4. 创建控制器，并使用Swagger的注解来描述控制器和接口： ``` @RestController @RequestMapping("/users") @Api(tags = "用户管理") public class UserController { @PostMapping("") @ApiOperation(value = "创建用户") public User createUser(@RequestBody @ApiParam(value = "用户信息") User user) { // 创建用户的逻辑 } @GetMapping("/{id}") @ApiOperation(value = "查询用户") public User getUser(@PathVariable Long id) { // 查询用户的逻辑 } // 省略其它接口 } ``` 5. 启动项目，并访问http://localhost:8080/swagger-ui.html，即可看到Swagger的UI界面，可以通过界面来测试接口。 以上就是生成Swagger的实体类和controller的过程，希望能帮到你。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值