问OpenAPI（Swagger-UI ) 相同的Java模型类，如何指定某些API某个字段是必需的？

提问于 2023-02-10 10:40:23

回答 0关注 0查看 57

我目前正在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所需的字段？

java