How to set description to a field using swagger OpenAPI annotations

Question

To improve our api documentation I want to add a description to a field of a response body

as an example see the default petstore spec here: https://editor.swagger.io/

In the POST /pet in the pet response, status has the description "pet status in the store"

How can I do this from an annotation perspective in my code base?

(swagger v3)

@ringadingding that annotation doesn't exist in the v3 library — Viktor Baert, Jan 20 '21 at 14:30
I should have paid more attention to your question Viktor. It is recommended that "@ApiModel" should be replaced by "@Schema". You can find reference at following link https://springdoc.org/#swagger-ui-properties — ringadingding, Jan 20 '21 at 14:44
@ringadingding just letting you I managed to solve it :). Thanks for your comment — Viktor Baert, Jan 20 '21 at 20:19

score 9 · Accepted Answer · answered Jan 20 '21 at 20:23

9

solution in kotlin:

data class Pet(
        @field:Schema(description = "Pet status in the store")
        val status: String
     )

answered Jan 20 '21 at 20:23

Viktor Baert

686
8
22

score 7 · Answer 2 · answered Feb 22 '22 at 10:19

7


import io.swagger.v3.oas.annotations.media.Schema;

public class Pet {
    @Schema(description = "Pet status in the store")
    private String status;
}

thanks @viktor-baert

answered Feb 22 '22 at 10:19

Dennis Gloss

2,307
4
21
27

How to set description to a field using swagger OpenAPI annotations

2 Answers2