OpenAPI（Swagger-UI）-仅某些API的必填字段

Question

我目前正在Spring Boot应用程序中使用OpenAPI 3（Swigger UI），我想知道如果我对所有API都使用相同的Java模型类，如何只为某些API指定某个字段是必需的/可选的。

这是我的样本：

@Getter
@Setter
@Accessors(chain = true)
@NoArgsConstructor
@JsonIgnoreProperties(ignoreUnknown = true)
public class UserRequest {
  @NotEmpty(message = "{constraints.NotEmpty.message}")
  private String username;
  @NotEmpty(message = "{constraints.NotEmpty.message}")
  private String password;
  @NotEmpty(message = "{constraints.NotEmpty.message}")
  private String cookie;
  @NotEmpty(message = "{constraints.NotEmpty.message}")
  private String csrfToken;
}

这个类被用作几个API的输入请求，但只有其中一些API会要求这些字段都是必需的（即“密码”字段仅对登录API是必需的，而对注销API不是必需的）。

有没有一种方法可以使用OpenAPI的注释来突出显示需要的API所需的字段？

提前谢谢你的帮助。

早上好。

Answer 1

我认为，在这个类中，您将无法指定参数是强制的还是非强制的，有些选项是在API定义中执行（特别是强制参数），或者，如果从主体中检索该类，则创建验证服务来验证字段值，甚至使用DTO隐藏您不想设置的字段并指定强制的字段，在此选项中，mapstruct将非常有用。https://mapstruct.org/

我希望这有助于，问候！

编辑：这里是一些DTO信息什么是数据传输对象（DTO）？