如何在Swagger的POST /bar请求中仅显示Foo的id字段且不影响Foo接口

完全可以实现，核心是让Swagger在不同接口场景下识别DTO的不同字段集合，下面提供两种常用方案：

方案一：创建专用请求DTO（推荐） #

这种方式代码逻辑清晰，避免注解耦合，适合大多数场景：

1. 为Bar的POST请求单独创建请求类，里面包含简化版的Foo引用（仅保留id字段）：

// 仅用于Bar的POST请求，只保留Foo的必填id
class FooReference {
    @NotNull
    private String id;
    // 仅实现id的getter/setter
}

class BarCreateRequest {
    @NotNull
    private String id;
    @NotNull
    private FooReference foo;
    // 实现id和foo的getter/setter
}

2. 在Bar的POST控制器方法中，接收BarCreateRequest作为请求体，之后再转换为原Bar实体进行业务处理：

@PostMapping("/bar")
public ResponseEntity<Bar> createBar(@RequestBody BarCreateRequest request) {
    // 转换request为Bar实体
    Bar bar = new Bar();
    bar.setId(request.getId());
    
    Foo foo = new Foo();
    foo.setId(request.getFoo().getId());
    // 如需其他Foo字段，可从数据库查询补充
    bar.setFoo(foo);
    
    // 后续业务逻辑...
    return ResponseEntity.ok(bar);
}

3. Foo自身的POST接口依然使用原Foo类，保持显示所有必填字段：

@PostMapping("/foo")
public ResponseEntity<Foo> createFoo(@RequestBody Foo foo) {
    // 业务逻辑...
    return ResponseEntity.ok(foo);
}

这样Swagger文档中，POST /bar的请求体只会显示Foo的id字段，POST /foo则显示全部字段。

方案二：利用Swagger注解分组（无需新增类） #

如果不想创建新的DTO类，可以通过Swagger的@Schema分组功能实现：
以SpringDoc为例（Springfox逻辑类似，使用@ApiOperation的分组属性）：

1. 给Foo类的字段添加分组标记：

class Foo {
    // 同时属于完整视图和引用视图
    @Schema(requiredMode = RequiredMode.REQUIRED, groups = {FullFoo.class, FooReference.class})
    private String id;
    
    // 仅属于完整视图
    @Schema(requiredMode = RequiredMode.REQUIRED, groups = {FullFoo.class})
    private String name;
    
    // 定义分组标记接口（无需实现）
    public interface FullFoo {}
    public interface FooReference {}
}

2. 给Bar类的foo字段指定引用分组：

class Bar {
    @Schema(requiredMode = RequiredMode.REQUIRED)
    private String id;
    
    // 指定只显示FooReference分组的字段
    @Schema(groups = {Foo.FooReference.class})
    private Foo foo;
}

3. 在控制器方法中指定对应的分组：

// Foo的POST接口使用完整分组，显示所有字段
@PostMapping("/foo")
public ResponseEntity<Foo> createFoo(
    @RequestBody @Schema(groups = Foo.FullFoo.class) Foo foo
) {
    // 业务逻辑...
    return ResponseEntity.ok(foo);
}

// Bar的POST接口使用引用分组，仅显示Foo的id
@PostMapping("/bar")
public ResponseEntity<Bar> createBar(
    @RequestBody @Schema(groups = Foo.FooReference.class) Bar bar
) {
    // 业务逻辑...
    return ResponseEntity.ok(bar);
}

通过这种方式，Swagger会根据接口指定的分组，自动筛选显示对应的字段。

方案对比 #

• 专用DTO方案：代码结构清晰，降低耦合，后期维护更方便，适合复杂业务场景
• 注解分组方案：无需新增类，代码更简洁，但需要维护分组接口，适合简单场景

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