Api annotation's description is deprecated

Question

In Swagger, the @Api annotation\'s description element is deprecated.

Deprecated. Not used in 1.5.X, kept for legacy support.

Answer 1

This is the correct way to add description to your Swagger API documentation for Swagger v1.5:

@Api(tags = {"Swagger Resource"})
@SwaggerDefinition(tags = {
    @Tag(name = "Swagger Resource", description = "Write description here")
})
public class ... {
}