解决Swagger显示ResponseEntity而非实际数据类型的问题

摘要：在Swagger中，有时会遇到生成ResponseEntity而非实际数据类型的问题。这通常是由于API接口定义与Swagger配置不匹配所导致。为了解决此问题，需要检查API接口的返回类型，并确保Swagger配置中正确映射了实际的数据类型。还需要检查Swagger注解的使用是否正确，并确保Spring Boot应用程序的版本与Swagger插件兼容。通过以上步骤，可以有效地解决Swagger生成ResponseEntity而非实际数据类型的问题。

本文旨在解决在使用Spring `ResponseEntity`返回API响应时，Swagger无法正确识别并生成预期数据模型的问题。核心在于当`ResponseEntity`未指定泛型类型时，Swagger难以推断实际响应结构。通过为`ResponseEntity`明确指定泛型类型，并合理处理不同HTTP状态下的响应体，我们可以确保Swagger准确地展示API的输出模型，同时保留自定义HTTP状态码的能力。

深入理解Swagger与ResponseEntity的交互问题

在Spring Boot应用中，我们经常使用ResponseEntity来构建灵活的HTTP响应，它允许我们自定义状态码、头部信息和响应体。然而，当ResponseEntity与Swagger（或OpenAPI）结合使用时，如果不注意其类型定义，可能会导致API文档生成不准确。

考虑以下初始代码示例，它尝试根据用户权限返回激活码列表或未登录提示：

@ApiOperation(value = "show code")
@GetMapping("/showActivationCode")
@ApiResponses(
        {
                @ApiResponse(code = 200, message = "OK"),
                @ApiResponse(code = 403, message = "Not login"),
        })
public ResponseEntity showActivationCode() { // 注意这里ResponseEntity没有指定泛型类型
    if (session.getAttribute("isAdmin") == "1") {
        return ResponseEntity.status(200).body(userService.getActiveCode());
    } else {
        return ResponseEntity.status(403).body("Not login");
    }
}

其中userService.getActiveCode()返回List<ActiveCode>。当我们期望Swagger能展示ActiveCode对象的列表结构时，实际生成的Swagger文档却可能显示一个通用的ResponseEntity结构，例如：

{
  "body": {},
  "statusCode": "ACCEPTED",
  "statusCodeValue": 0
}

这种情况下，Swagger无法推断出body字段的具体类型，因为它接收的是一个原始（raw）的ResponseEntity类型。

为什么会出现这个问题？

Swagger在生成API文档时，会尝试通过反射等机制分析Java方法的返回类型。当方法返回ResponseEntity而没有指定泛型类型时，Java编译器将其视为ResponseEntity<Object>，这意味着响应体可以是任何类型。Swagger在面对这种不确定性时，为了通用性，通常会生成一个包含body、statusCode和statusCodeValue等字段的通用ResponseEntity模型，而无法深入到body内部的具体数据结构。

尝试解决：直接返回数据类型（但有局限性）

为了让Swagger正确显示数据结构，一个直观的尝试是直接返回数据类型，而不是ResponseEntity：

@ApiOperation(value = "show code")
@GetMapping("/showActivationCode")
@ApiResponses(
        {
                @ApiResponse(code = 200, message = "OK"),
                @ApiResponse(code = 403, message = "Not login"),
        })
public List<ActiveCode> showActivationCode() { // 直接返回List<ActiveCode>
    if (session.getAttribute("isAdmin") == "1") {
        return userService.getActiveCode();
    } else {
        // 无法直接返回自定义HTTP状态码，只能返回null或抛出异常
        return null;
    }
}

这种方式确实能让Swagger正确生成List<ActiveCode>的Schema。然而，它的主要缺点是失去了ResponseEntity提供的高度灵活性，例如无法自定义HTTP状态码（如403）或添加自定义头部信息。在上述示例中，当用户未登录时，我们只能返回null，而无法返回403状态码并附带“Not login”的错误信息，这不符合RESTful API的设计原则。

最佳实践：使用泛型明确指定ResponseEntity的类型

要同时满足Swagger的文档生成需求和API的灵活性，关键在于为ResponseEntity明确指定其泛型类型。这样，Swagger就能根据泛型信息正确地推断响应体的结构。

以下是修正后的代码示例：

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

import javax.servlet.http.HttpSession;
import java.util.Collections;
import java.util.List;

@RestController
public class ActivationCodeController {

    private final UserService userService; // 假设注入UserService
    private final HttpSession session; // 假设注入HttpSession

    public ActivationCodeController(UserService userService, HttpSession session) {
        this.userService = userService;
        this.session = session;
    }

    @ApiOperation(value = "显示激活码")
    @GetMapping("/showActivationCode")
    @ApiResponses(
            {
                    @ApiResponse(code = 200, message = "成功获取激活码列表", response = ActiveCode.class, responseContainer = "List"),
                    @ApiResponse(code = 403, message = "未登录或无权限", response = Void.class) // 对于403，响应体可能为空或通用错误信息
            })
    public ResponseEntity<List<ActiveCode>> showActivationCode() {
        if ("1".equals(session.getAttribute("isAdmin"))) { // 推荐使用equals进行字符串比较
            return ResponseEntity.status(200).body(userService.getActiveCode());
        } else {
            // 在无权限的情况下，返回403状态码，并保持响应体类型与泛型一致
            // 可以返回一个空列表，或者在更复杂的场景下返回一个自定义的错误对象
            return ResponseEntity.status(403).body(Collections.emptyList());
            // 或者：
            // return ResponseEntity.status(403).body(null);
            // 注意：如果403的响应体预期是错误消息字符串，则需要更复杂的泛型处理，
            // 例如使用ResponseEntity<Object>或自定义ErrorResponse对象。
        }
    }
}

// 假设ActiveCode和UserService的定义如下：
class ActiveCode {
    private String code;
    private String isAdmin;
    private String name;

    // Getters and Setters
    public String getCode() { return code; }
    public void setCode(String code) { this.code = code; }
    public String getIsAdmin() { return isAdmin; }
    public void setIsAdmin(String isAdmin) { this.isAdmin = isAdmin; }
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
}

class UserService {
    private ActiveCodeDao activeCodeDao; // 假设注入ActiveCodeDao

    public UserService(ActiveCodeDao activeCodeDao) {
        this.activeCodeDao = activeCodeDao;
    }

    public List<ActiveCode> getActiveCode() {
        return activeCodeDao.getActiveCodeListDao();
    }
}

class ActiveCodeDao {
    public List<ActiveCode> getActiveCodeListDao() {
        // 模拟数据
        return List.of(
            new ActiveCode() {{ setCode("A1"); setIsAdmin("0"); setName("UserA"); }},
            new ActiveCode() {{ setCode("A2"); setIsAdmin("1"); setName("UserB"); }}
        );
    }
}

通过将方法的返回类型定义为ResponseEntity<List<ActiveCode>>，我们明确告诉了Java编译器和Swagger，当HTTP状态码为200时，响应体将是一个ActiveCode对象的列表。即使在403这样的错误状态下，为了保持泛型类型的一致性，我们仍然返回一个List<ActiveCode>类型的值（例如一个空列表Collections.emptyList()或null）。

此时，Swagger将能够正确地生成如下所示的API响应模型：

[
  {
    "code": "string",
    "isAdmin": "string",
    "name": "string"
  }
]

这正是我们所期望的，Swagger清晰地展示了响应体的数据结构。

注意事项与进阶处理

1. 类型一致性： 当使用ResponseEntity<T>时，务必确保在所有可能的返回路径中，body()方法中传入的对象类型与T兼容。

2. 错误响应体： 在上述示例中，对于403错误，我们返回了一个空列表。但在实际的API设计中，403错误通常会伴随一个描述错误的JSON对象，而不是空数据列表。如果你的API规范要求403返回一个错误消息对象，那么你需要：

   • 定义一个通用的错误响应类，例如ErrorResponse。
   • 将ResponseEntity的泛型类型设置为ResponseEntity<Object>或ResponseEntity<?>，然后在@ApiResponses中明确指定不同状态码下的response类型。
   • 或者，为不同的错误响应定义不同的API端点，或者在@ApiResponses中更细致地描述。
   • 一个更健壮的方法是，对于成功的响应使用ResponseEntity<List<ActiveCode>>，而对于错误响应，可能需要返回ResponseEntity<ErrorResponse>，这通常意味着你的方法需要返回ResponseEntity<?>或ResponseEntity<Object>，然后在@ApiResponses中通过@ApiResponse的response属性为不同的状态码指定不同的响应模型。

   例如，可以这样处理：

   // ... 其他代码 ...
   @ApiResponses(
           {
                   @ApiResponse(code = 200, message = "成功获取激活码列表", response = ActiveCode.class, responseContainer = "List"),
                   @ApiResponse(code = 403, message = "未登录或无权限", response = ErrorResponse.class) // 假设定义了ErrorResponse
           })
   public ResponseEntity<?> showActivationCode() { // 返回类型为通用的ResponseEntity<?>
       if ("1".equals(session.getAttribute("isAdmin"))) {
           return ResponseEntity.status(200).body(userService.getActiveCode());
       } else {
           return ResponseEntity.status(403).body(new ErrorResponse("Not login", 403));
       }
   }
   // 假设ErrorResponse类
   class ErrorResponse {
       private String message;
       private int code;
       // 构造器、Getter/Setter
   }

   这种方式在@ApiResponses中明确指定了不同状态码对应的响应模型，Swagger会根据这些注解生成更准确的文档。

总结

在使用Spring Boot和Swagger构建API时，确保Swagger能正确生成API文档的关键在于为ResponseEntity明确指定其泛型类型。这不仅有助于Swagger准确推断响应体的数据结构，还能保留ResponseEntity在自定义HTTP状态码和头部信息方面的灵活性。在处理不同HTTP状态下的响应体时，应尽量保持类型一致性，或通过@ApiResponses注解明确指定不同状态码下的响应模型，以提供清晰、专业的API文档。

本文转载于：互联网 如有侵犯，请联系zhengruancom@outlook.com删除。
免责声明：正软商城发布此文仅为传递信息，不代表正软商城认同其观点或证实其描述。