如何使用springdoc openapi和Lombok getter将@JsonValue用于招摇过市的枚举值

Question

给定一个Spring Boot项目，该项目使用springdoc-openapi库公开一个OpenAPI（Swagger）endpoint，该endpoint记录了项目的Spring MVC控制器endpoint。

项目中的一个枚举使用Jackson在字段上提供的JsonValue来更改枚举的JSON表示形式。使用Lombok项目的getter注释将此枚举字段公开为getter：

@Getter
public enum Suit {
    HEARTS("Hearts"), DIAMONDS("Diamonds"), CLUBS("Clubs"), SPADES("Spades");

    @JsonValue
    private final String name;

    Suit(String name) { this.name = name; }
}

然而，尽管Jackson表示基于字段，但OpenAPIendpoint返回的枚举表示使用枚举的值：

"suit": {
  "type": "string",
  "enum": [
    "HEARTS",
    "DIAMONDS",
    "CLUBS",
    "SPADES"
  ]
}

预期：

"suit": {
  "type": "string",
  "enum": [
    "Hearts",
    "Diamonds",
    "Clubs",
    "Spades"
  ]
}

基于springdoc openapi#1244和swagger core#3998，显然需要将注释应用于方法，而不是字段。然而，上述尝试的方法和以下方法均无效：

@Getter @JsonValue
public enum Suit {
    HEARTS("Hearts"), DIAMONDS("Diamonds"), CLUBS("Clubs"), SPADES("Spades");

    private final String name;

    Suit(String name) { this.name = name; }
}

如何在Swagger中使用正确的值公开此枚举，同时仍使用Lombok生成getter？

Answer 1

解决方案是告诉Lombok在生成的getter方法上使用注释，在字段上使用getter（onMethod\u=@JsonValue）。

public enum Suit {
    HEARTS("Hearts"), DIAMONDS("Diamonds"), CLUBS("Clubs"), SPADES("Spades");

    @Getter(onMethod_ = @JsonValue)
    private final String name;

    Suit(String name) { this.name = name; }
}

onMethod属性记录在@Getter和@Setter以及onX留档中：

要在生成的方法上添加注释，可以使用onMethod=@\uu（{@AnnotationsHere}）。[…]有关更多详细信息，请参阅有关onX功能的文档。

语法有点奇怪，这取决于您使用的javac
在javac7上，要使用3个onX功能中的任何一个，您必须将要应用于构造函数/方法/参数的注释包装在@（@annotationgoesher）中。若要应用多个批注，请使用（{@Annotation1，@Annotation2}）。注释本身显然也可以有参数
在javac8及以上版本中，可以在方法、参数或构造函数后添加下划线。