修改Swagger接口文档网络请求返回状态码

首先，我们查看Docket的源码，可以看到有一个控制返回码的字段属性

以及对应的方法

可见，我们要创建一个新的Docket实例，并在其中修改返回码配置

参考globalResponses方法，我们需要准备好两个参数，HttpMethod和Response的List

查看HttpMethod源码，易得即是一个常用请求方法的枚举类：

查看Response的源码，我们仅需要准备好code、description即可

因此，我在model包中定义一个ResultCode的枚举类，并作简单的封装

package tech.maiquer.metrichall.model;public enum ResultCode {SUCCESS(200, "成功"),PARAM_IS_INVALID(1001, "参数无效"),PARAM_IS_BLANK(1002, "参数为空"),USER_NOT_LOGGED_IN(2001, "用户未登录"),USER_LOGIN_ERROR(2002, "用户不存在或密码错误"),USER_NOT_EXIST(2003, "用户不存在"),USER_HAS_EXISTED(2004, "用户已存在"),INSERT_FAIL(3001, "添加失败"),DELETE_FAIL(3002, "删除失败"),UPDATE_FAIL(3003, "更新失败"),QUERY_FAIL(3004, "查询为空");private Integer code;private String message;public Integer getCode() {return code;}public String getMessage() {return message;}ResultCode(Integer code, String message) {this.code = code;this.message = message;}}

在SwaggerConfig中，通过流操作，封装好自定义的返回状态码到Response的List列表中，并将其封装到Docket实例并返回

封装Response并组装

@Beanpublic Docket docket() {List<Response> responseList = new ArrayList<>();Arrays.stream(ResultCode.values()).forEach(resultCode -> {responseList.add(new ResponseBuilder().code(resultCode.getCode().toString()).description(resultCode.getMessage()).build());});return new Docket(DocumentationType.OAS_30).globalResponses(GET, responseList).globalResponses(POST, responseList).globalResponses(PUT, responseList).globalResponses(DELETE, responseList);}

查看效果：

修改Swagger接口文档网络请求返回状态码相关推荐

HTTP网络请求返回状态码
HTTP状态码表示客户端HTTP请求的返回结果.标记服务器端的处理是否正常或者是出现的错误,能够根据返回的状态码判断请求是否得到正确的处理很重要. 平时在开发的时候,也能通过查看此状态码更快的获取的错 ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
SpringBoot集成knife4j实现Swagger接口文档
前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...
【愚公系列】2023年02月 WMS智能仓储系统-007.Swagger接口文档的配置
文章目录前言一.Swagger接口文档的配置 1.安装包 2.注入 2.1 Swagger服务的注入 2.2 appsetting.json的配置 2.3 Swagger服务的封装 2.3.1 S ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
swagger接口文档使用
swagger接口文档一,swagger简介前后端分离 swagger 诞生二,springboot集成swagger 依赖编写helloworld接口配置swagger ==> co ...
整合Swagger接口文档
Swagger接口文档:自动生成接口文档 1.添加依赖: <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagg ...
python实现处理swagger接口文档，转换为yaml格式的自动化用例
前言之前有很多小伙伴反馈,希望我出一期将swagger文档转换为 yaml格式的自动化用例,那么本期福利来咯~~这一篇文档,将会带领你们实现如何通过 swagger文档转换为 yaml格式的用例 ...
sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
swagger接口文档出现的空文档问题
记一次使用swagger接口文档出现的空文档问题问题描述: 上面显示的一些空文档下面的才是真正的正确文档: 最终尝试发现问题: 原因:**@Api(value = "ExamPaperC ...

修改Swagger接口文档网络请求返回状态码

修改Swagger接口文档网络请求返回状态码相关推荐

最新文章

热门文章