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 = @Content(examples = { @ExampleObject( name = "Person sample", summary = "person example", value = "{"email": test@ gmail.Com," + ""firstName": "josh"," + ""lastName": "spring..."" + "}") }))

我得到低于 excptiontion -

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;