Springdoc Openapi - 添加响应示例值

Question

我正在尝试将示例响应值添加到我的 springdoc-openapi swagger 文档中。

喜欢用“Mark Twain”等替换“string”

我试过使用这个解决方案 - springdoc-openapi: How to add example of POST request?

我已经在 class 中使用 org.springframework.web.bind.annotation.RequestBody。

如果我用这个 -
@io.swagger.v3.oas.annotations.parameters.RequestBody(内容=@Content(例子={ @ExampleObject( name = "人物样本", summary = "人的例子", 价值= “{“电子邮件”：test@gmail.Com，” + ""firstName": "乔希"," + ""lastName": "spring..."" + "}") }))

我低于异常值 -

no viable alternative at input ',@io.swagger.v3.oas.annotations.parameters.RequestBody(content=@Content(examples={@ExampleObject(name="Person sample",summary="person example",value="{\"email\": test@gmail.Com,"+"\"firstName\": \"josh\","+"\"lastName\": \"spring...\""+"}")})))': NoViableAltException

谁能给我一个解决方案吗？

Answer 1

这对我有用

@Schema( type = "string", example = "Clark Kent")
private String name;