解决Swagger 3中`Unable to scan documentation context default`错误

李少兄2024-10-10 21:23

背景

在开发Spring Boot应用时，我们经常使用Swagger来生成API文档。但在某些情况下，可能会遇到Unable to scan documentation context default这样的异常信息，尤其是在Controller的方法参数列表中有两个实体类且它们包含相同的字段名时。

问题描述

当我们的Controller方法签名如下所示：

java 复制代码

public void addTask(Model1 model1, Model2 model2) {
    // 方法体
}

如果Model1和Model2中都含有一个名为id的属性，则Spring MVC框架将无法确定如何绑定传入的数据到这两个同名的属性上，从而引发Unable to scan documentation context default错误。

原因分析

该错误的根本原因在于Spring MVC不知道如何解析具有相同名称的多个参数。这会导致Swagger在尝试扫描并生成API文档时失败，因为它依赖于正确的参数绑定来进行文档化处理。

解决方案

方案一：更改字段名称

最直接的解决方案是修改实体类中的字段名，确保每个实体内的字段名都是唯一的。例如，可以将Model2中的id字段改名为model2Id。

java 复制代码

public class Model1 {
    private Long id;
    // 其他属性及getter/setter省略
}

public class Model2 {
    private Long model2Id; // 修改了字段名
    // 其他属性及getter/setter省略
}

方案二：创建新的DTO

另一种方法是为这个特定场景创建一个新的数据传输对象（DTO），将Model1和Model2的必要属性封装在一起。然后，在Controller方法中仅接受这个新的DTO作为输入参数。

java 复制代码

public class TaskRequestDTO {
    private Model1 model1;
    private Model2 model2;
    
    // 构造函数、getter和setter等省略
}

// Controller方法更新
public void addTask(@RequestBody TaskRequestDTO taskRequest) {
    // 处理逻辑
}

这样做不仅解决了字段冲突的问题，还可能使你的API设计更加清晰易懂。

结论

通过上述两种方法之一，我们可以有效地解决由于实体类之间存在同名字段而导致的Unable to scan documentation context default错误。