Use name as optional param in Tag

[rcbandit111]

I use this to add controller description:

@Tag(
		name = "User API",
		description = "Operations related to user management such as create, update, delete and retrieval."
)
@RestController
@RequestMapping(value = "/productgroup")
public class ProductGroupController {
}

but when I remove name = "User API", I get error 'name' missing but required. Any way how to keep the description without overriding the controller name?

[Mattias-Sehlstedt]

What is the background for trying to use the @Tag annotation? As per the documentation it is a tool for grouping operations (and a group needs a name). It sound like you want to decorate a single operation, so maybe @Operation offers what you are looking for?

[rcbandit111]

I just want to add description of a rest controller into spring doc url.

I tried to add

@Operation(summary = "sdvsdvdvsdvdsvds")
@RestController

But I get @Operation' not applicable to type

Any other solution?

[Mattias-Sehlstedt]

A rest controller does not have a native translation within an OpenApi specification. The server can define the controllers however it wants, and you can then elect how to present all the endpoint (operations) in the specification. The usual way of doing it is to have each controller define the @Tag that you tried before, so that the operations are presented in the specification like how they are ordered within the controllers.

Another way is to define @Operation on each endpoint, so that each endpoint gets a description.

I would strongly suggest that you either clone down the repo and look at how this is used within different controller tests, or look at the documentation over at swagger-core, that offers the annotations.