How do I add more information about APIs in Swagger?

Question

I included swagger-springmvc in my project and managed to get the Swagger UI working, but right now there's very little information about the APIs in the UI. All I see is information extracted through reflection.

This is what a controller method looks like:

/** * Read all users matching given filter * @param String filter The text by which to filter the usernames * @return User[] Array of users matching given filter * @throws Exception */ @RequestMapping(value = "/users/{filter}", method = RequestMethod.GET) public @ResponseBody Collection<User> getUsers(@PathVariable("filter") String filter) throws Exception { return domain.getUsersFilteredBy(filter); }

And on the right side of each method Swagger documents the method's name, in this case:

get Users

but I was expecting to see this:

Read all users matching given filter

In the example on helloreverb.com, I see the description of each of those methods. How can I get swagger to add the descriptions of my controller methods to the UI like so?

Swagger documentation example

Jim K · Accepted Answer · 2014-05-16 17:39:17Z

@ApiOperation(value = "Read all users matching given filter", notes = "Will get all the users for the given filter")

lzr · Accepted Answer · 2021-08-18 09:39:47Z

Use @Operation from package io.swagger.v3.oas.annotations;

@GetMapping @Operation(summary = "My Summary", description = "My Description") public Object getSomeObject(){..}

Collectives™ on Stack Overflow

How do I add more information about APIs in Swagger?

2 Answers 2

Comments

Comments

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Related