Springdoc Openapi - Add Response Example Value

Question

I'm trying to add example response values to my springdoc-openapi swagger documentation.

Like replace the "string" with "Mark Twain" etc.

I tried using this solution - springdoc-openapi: How to add example of POST request?

I'm already using org.springframework.web.bind.annotation.RequestBody in my class.

If I use this -

@io.swagger.v3.oas.annotations.parameters.RequestBody(content = @Content(examples = {
                @ExampleObject(
                        name = "Person sample",
                        summary = "person example",
                        value =
                                "{\"email\": [email protected],"
                                        + "\"firstName\": \"josh\","
                                        + "\"lastName\": \"spring...\""
                                        + "}")
        }))

I get below exception -

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

Can anyone give me a solution please?

Rabin Mallilck · Accepted Answer · 2022-03-31 12:33:21Z

12

This worked for me

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

answered Mar 31, 2022 at 12:33

Rabin Mallilck

4816 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Springdoc Openapi - Add Response Example Value

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related