OpenAPI 生成器在字段级别添加注释

Question

I am using openapi generator (5.4.0) with gradle(7.3.3) and SpringBoot (2.6.6).

my OpenApi configuration:

  ext.openApiConfigOptions = [
            library                       : "spring-boot",
            dateLibrary                   : "java8",
            delegatePattern               : "true",
            useTags                       : "true",
            openApiNullable               : "false",
            additionalModelTypeAnnotations: "@lombok.Builder @lombok.NoArgsConstructor @lombok.AllArgsConstructor",
            booleanGetterPrefix           : "is"
    ]

My goal is to add the @lombok.Builder.Default annotation over the field.

From documentation:

According to this: link to example I tried using x-field-extra-annotation: in my spec, but it doesn't work in my case.

In my case it works like this;

• x-extra-annotation:"@lombok.Builder.Default" adds an annotation over the getter.
• The; x-setter-extra-annotation:"@lombok.Builder.Default" results in adding an annotation to the setter.
• But; x-field-extra-annotation has no effect.

Similar unanswered question: link

Answer 1

将 openapi 生成器升级到 6.0.0 版本即可解决问题。

Answer 2

You tried with x-field-extra-annotation, but that is for field only. If you want to add it on the class level, you can use x-class-extra-annotation. Example:

ArticlesDto:
  x-class-extra-annotation: '@com.fasterxml.jackson.annotation.JsonInclude(com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL)'
  type: object
  properties:
    articles:
      type: array
      items:
        $ref: '#/components/schemas/ArticleDto'
      description: 'list of articles'
    pageable:
      $ref: '#/components/schemas/PageRequestDto'