如何在 openapi 规范 3 中使用 java 自定义注释

Question

只是想知道是否有一种方法可以在 openapi 规范中使用我的自定义注释。

设想-

用户对象-我需要在用户名或 email 之间进行非空验证。应在请求中提供其中之一

为此，我可以在类似@ValidateUserNameAndEmail的代码中创建一个自定义注释，但没有找到一种方法在 openapi 规范中应用它并像生成代码中的其他注释一样包含它。

Answer 1

我不认为这是可能的。 您可以使用 openapi 提供的验证注解，例如 @NotNull

Answer 2

我使用最新版本 (6.2.1) 的openapi-generator-maven-plugin和以下适合我的作品。

User:
  type: object
  x-class-extra-annotation: "@org.example.ValidateUsernameAndEmail"
  ...

该插件生成以下 class：

@Schema(name = "User ")
@Generated(value = "org.openapitools.codegen.languages.SpringCodegen", date = "2022-11-24T14:51:09.277810200+01:00[Europe/Prague]")
@org.example.ValidateUsernameAndEmail
public class User {
    ...
}

如果需要，您还可以使用x-field-extra-annotation定义字段级注释。