JHipster SpringBoot项目配置Swagger自定义400错误JSON响应失败求助

首先明确：Swagger的yml配置仅用于定义API文档的示例响应，不会修改SpringBoot实际的错误返回逻辑，这是你之前配置无效的核心原因。要实现400错误返回指定静态JSON，需要修改SpringBoot的错误处理机制，以下是两种可行方案：

方案一：全局异常处理器（精准处理400相关异常） #

通过@ControllerAdvice定义全局异常处理器，捕获所有导致HTTP 400的异常并返回自定义响应：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MissingServletRequestParameterException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;

import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
public class CustomGlobalExceptionHandler {

    // 处理参数校验失败触发的400异常
    @ExceptionHandler(BindException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<Map<String, Object>> handleValidationException() {
        Map<String, Object> errorResponse = new HashMap<>();
        errorResponse.put("ErrorID", -1);
        errorResponse.put("CustomMessage", "ERROR");
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    // 处理请求参数缺失触发的400异常
    @ExceptionHandler(MissingServletRequestParameterException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public ResponseEntity<Map<String, Object>> handleMissingParamsException() {
        Map<String, Object> errorResponse = new HashMap<>();
        errorResponse.put("ErrorID", -1);
        errorResponse.put("CustomMessage", "ERROR");
        return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
    }

    // 可根据需求添加更多400类型异常的处理（如ServletRequestBindingException等）
}

方案二：自定义ErrorController（统一接管所有错误） #

实现SpringBoot的ErrorController接口，替换默认错误处理逻辑，对400错误返回指定JSON：

import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

@RestController
public class CustomErrorController implements ErrorController {

    @RequestMapping("/error")
    public ResponseEntity<Map<String, Object>> handleError(HttpServletRequest request) {
        Object statusObj = request.getAttribute("javax.servlet.error.status_code");
        Map<String, Object> errorResponse = new HashMap<>();

        if (statusObj != null) {
            int statusCode = Integer.parseInt(statusObj.toString());
            if (statusCode == HttpStatus.BAD_REQUEST.value()) {
                errorResponse.put("ErrorID", -1);
                errorResponse.put("CustomMessage", "ERROR");
                return new ResponseEntity<>(errorResponse, HttpStatus.BAD_REQUEST);
            }
            // 可扩展处理其他HTTP状态码的错误响应
        }

        // 默认错误响应（可选）
        errorResponse.put("ErrorID", 0);
        errorResponse.put("CustomMessage", "UNKNOWN ERROR");
        return new ResponseEntity<>(errorResponse, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

配合Swagger文档显示自定义示例 #

完成上述错误处理配置后，可在Swagger的yml配置中添加示例响应，让API文档展示自定义的400返回结构：

paths:
  /your-target-api:
    post:
      # 其他配置（请求参数、摘要等）
      responses:
        400:
          description: 请求参数错误
          schema:
            type: object
            properties:
              ErrorID:
                type: integer
                example: -1
              CustomMessage:
                type: string
                example: ERROR

注意事项 #

• 确保自定义类被SpringBoot扫描到（放在主应用类的同包或子包下）
• 如果项目中存在JHipster默认的错误处理类，可给自定义的@ControllerAdvice添加@Order(Ordered.HIGHEST_PRECEDENCE)提升优先级，确保自定义逻辑先执行

内容的提问来源于stack exchange，提问作者NeptuneZ