How to set description to a field using swagger OpenAPI annotations

user_10263616 0
Viewed 2512

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)

springdoc-openapi-ui swagger openapi spring-boot
2 Answers

solution in kotlin:

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

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

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

thanks @viktor-baert

user_101608650
Related