默认的全局异常提示需要怎样才能配置到swagger上

时间: 2024-04-22 12:23:35 浏览: 10
要将全局异常提示配置到Swagger上,可以使用Spring Boot提供的`@ControllerAdvice`注解来实现全局异常处理,并通过Swagger提供的`@ExceptionHandler`注解将其配置到Swagger上。具体步骤如下: 1. 创建一个全局异常处理器类,使用`@ControllerAdvice`注解标识该类为全局异常处理器。 ```java @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(Exception.class) public ResponseEntity<ErrorResponse> handleException(Exception ex) { ErrorResponse error = new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage()); return new ResponseEntity<>(error, HttpStatus.INTERNAL_SERVER_ERROR); } } ``` 在上面的代码中,我们定义了一个`handleException()`方法来处理`Exception`类型的异常,并将异常信息封装到一个`ErrorResponse`对象中返回。 2. 创建一个`ErrorResponse`类,用于封装异常信息。 ```java public class ErrorResponse { private int code; private String message; public ErrorResponse() {} public ErrorResponse(int code, String message) { this.code = code; this.message = message; } // getter and setter methods } ``` 3. 在Swagger配置类中添加一个`globalResponseMessage()`方法,用于配置全局响应消息。 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { // ... private List<ResponseMessage> globalResponseMessage() { List<ResponseMessage> responseMessages = new ArrayList<>(); responseMessages.add(new ResponseMessageBuilder() .code(HttpStatus.INTERNAL_SERVER_ERROR.value()) .message("系统异常") .responseModel(new ModelRef("ErrorResponse")) .build()); return responseMessages; } @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .globalResponseMessage(RequestMethod.GET, globalResponseMessage()) .globalResponseMessage(RequestMethod.POST, globalResponseMessage()) .globalResponseMessage(RequestMethod.PUT, globalResponseMessage()) .globalResponseMessage(RequestMethod.DELETE, globalResponseMessage()) .globalResponseMessage(RequestMethod.PATCH, globalResponseMessage()) .globalResponseMessage(RequestMethod.OPTIONS, globalResponseMessage()) .globalResponseMessage(RequestMethod.HEAD, globalResponseMessage()) .apiInfo(apiInfo()); } } ``` 在上面的代码中,我们定义了一个`globalResponseMessage()`方法,用于配置全局响应消息。在该方法中,我们创建了一个`ResponseMessage`对象,并设置了响应码、响应消息和响应模型。然后,我们在`Docket`配置中调用`globalResponseMessage()`方法,将全局响应消息配置到Swagger中。 4. 在Swagger配置类中添加一个`additionalModels()`方法,用于将`ErrorResponse`类注册到Swagger中。 ```java @Configuration @EnableSwagger2 public class SwaggerConfig { // ... private List<Model> additionalModels() { List<Model> models = new ArrayList<>(); models.add(new ModelBuilder() .name("ErrorResponse") .addProperty(new PropertyBuilder() .name("code") .type(ModelRef.INT32) .build()) .addProperty(new PropertyBuilder() .name("message") .type(ModelRef.STRING) .build()) .build()); return models; } @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build() .globalResponseMessage(RequestMethod.GET, globalResponseMessage()) .globalResponseMessage(RequestMethod.POST, globalResponseMessage()) .globalResponseMessage(RequestMethod.PUT, globalResponseMessage()) .globalResponseMessage(RequestMethod.DELETE, globalResponseMessage()) .globalResponseMessage(RequestMethod.PATCH, globalResponseMessage()) .globalResponseMessage(RequestMethod.OPTIONS, globalResponseMessage()) .globalResponseMessage(RequestMethod.HEAD, globalResponseMessage()) .additionalModels(additionalModels()) .apiInfo(apiInfo()); } } ``` 在上面的代码中,我们定义了一个`additionalModels()`方法,用于将`ErrorResponse`类注册到Swagger中。在该方法中,我们创建了一个`Model`对象,并设置了模型名称和模型属性。然后,我们在`Docket`配置中调用`additionalModels()`方法,将`ErrorResponse`类注册到Swagger中。 5. 运行项目,访问Swagger UI界面,即可看到全局异常提示信息已经成功配置到Swagger上。 参考链接:[Spring Boot全局异常处理与Swagger集成](https://www.jianshu.com/p/d4d1445fd596)

相关推荐

最新推荐

recommend-type

spring boot-2.1.16整合swagger-2.9.2 含yml配置文件的代码详解

主要介绍了spring boot-2.1.16整合swagger-2.9.2 含yml配置文件,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
recommend-type

SpringBoot整合Swagger2实例方法

在本篇文章里小编给大家整合了关于SpringBoot整合Swagger2的相关知识点内容,有兴趣的朋友们学习下。
recommend-type

Springboot引入拦截器并放行swagger代码实例

主要介绍了Springboot引入拦截器并放行swagger代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
recommend-type

SpringMVC如何在生产环境禁用Swagger的方法

本篇文章主要介绍了SpringMVC如何在生产环境禁用Swagger的方法,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
recommend-type

Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题

主要介绍了Spring Boot引入swagger-ui 后swagger-ui.html无法访问404的问题及解决方法,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
recommend-type

zigbee-cluster-library-specification

最新的zigbee-cluster-library-specification说明文档。
recommend-type

管理建模和仿真的文件

管理Boualem Benatallah引用此版本:布阿利姆·贝纳塔拉。管理建模和仿真。约瑟夫-傅立叶大学-格勒诺布尔第一大学,1996年。法语。NNT:电话:00345357HAL ID:电话:00345357https://theses.hal.science/tel-003453572008年12月9日提交HAL是一个多学科的开放存取档案馆,用于存放和传播科学研究论文,无论它们是否被公开。论文可以来自法国或国外的教学和研究机构,也可以来自公共或私人研究中心。L’archive ouverte pluridisciplinaire
recommend-type

实现实时数据湖架构:Kafka与Hive集成

![实现实时数据湖架构:Kafka与Hive集成](https://img-blog.csdnimg.cn/img_convert/10eb2e6972b3b6086286fc64c0b3ee41.jpeg) # 1. 实时数据湖架构概述** 实时数据湖是一种现代数据管理架构,它允许企业以低延迟的方式收集、存储和处理大量数据。与传统数据仓库不同,实时数据湖不依赖于预先定义的模式,而是采用灵活的架构,可以处理各种数据类型和格式。这种架构为企业提供了以下优势: - **实时洞察:**实时数据湖允许企业访问最新的数据,从而做出更明智的决策。 - **数据民主化:**实时数据湖使各种利益相关者都可
recommend-type

SPDK_NVMF_DISCOVERY_NQN是什么 有什么作用

SPDK_NVMF_DISCOVERY_NQN 是 SPDK (Storage Performance Development Kit) 中用于查询 NVMf (Non-Volatile Memory express over Fabrics) 存储设备名称的协议。NVMf 是一种基于网络的存储协议,可用于连接远程非易失性内存存储器。 SPDK_NVMF_DISCOVERY_NQN 的作用是让存储应用程序能够通过 SPDK 查询 NVMf 存储设备的名称,以便能够访问这些存储设备。通过查询 NVMf 存储设备名称,存储应用程序可以获取必要的信息,例如存储设备的IP地址、端口号、名称等,以便能
recommend-type

JSBSim Reference Manual

JSBSim参考手册,其中包含JSBSim简介,JSBSim配置文件xml的编写语法,编程手册以及一些应用实例等。其中有部分内容还没有写完,估计有生之年很难看到完整版了,但是内容还是很有参考价值的。