How to remove controller list from Swagger UI

Question

I'm using springfox-swagger-ui 2.8.0 which ships with Swagger UI 3.7.0.

I want to get rid of the controller list in front of the api documentation page, pretty useless for me (every tab is empty).

I've already tried to annotate the controller class with @ApiIgnore, but of course this removes the rest api documentation as well, which I need.

Basically, I want to remove this:

while keeping this:

I digged through online docs, GitHub issues, StackOverflow questions, Google... nothing. Am I the only with this request?

See this [answer](https://stackoverflow.com/a/55031852/4978689), I tried and it works. — mindOf_L, Dec 05 '20 at 23:50

score 32 · Answer 1 · answered Feb 15 '19 at 22:13

32

Try this attribute on the controller

[ApiExplorerSettings(IgnoreApi = true)]

answered Feb 15 '19 at 22:13

Victor Oniagba

441
1
4
8

If you're using ASPCore and need to assure the route is not accessible, add `app.Map("/api/values", delegate { });` to method `Configure` in `Startup.cs` – Adam Cox Mar 31 '19 at 03:02
1

Don't know if this attribute works in Java, but in ASP.Net Core 2.2 it works nice. The controller is still accessible via URL, but it's hidden from the swagger output. – ArieKanarie Jun 17 '19 at 11:02
Is there a way to add this dynamically at run-time? – JohnOpincar Jun 23 '21 at 12:59

score 13 · Accepted Answer · edited Jun 07 '18 at 10:55

13

Add the attribute description to @Api:

For example:

@Api(value = "Test API Controller", produces = MediaType.APPLICATION_JSON_VALUE, tags = {"test-api-controller"}, description = "Testing API")

edited Jun 07 '18 at 10:55

Vinay Prajapati

7,199
9
45
86

answered Jun 07 '18 at 10:46

Navin

146
1
3

2

I already had the description attribute (and it's marked as deprecated). Removing it changes nothing :-( – think01 Jun 08 '18 at 13:56
6

YES! Your hint led me to the right solution: adding @Api(tags = {"MagazzinoPF"}) to the implementation class. This someway "merges" the empty documentation line to the actual documentation below. If you modify your answer, I'll accept it. Thanks! – think01 Jun 08 '18 at 14:01
1

@think01 Solved my problem too. Do you think there is a way to add this when generating swagger code itself? – NuttLoose Sep 03 '18 at 11:30
@NuttLoose uhm, good idea, unfortunately I don't know how to achieve that. I'll look about it, if you find the way, please share it here ;-) – think01 Sep 04 '18 at 12:46
@think01 Will do. – NuttLoose Sep 05 '18 at 03:57
it hides both in 2.9.2 – Andrew Sneck May 22 '20 at 14:32
Are there any options to hide this on the generated swagger code? – Manoj Kumar S Mar 16 '21 at 05:52
its not clear from the ans, using the same tag name on some controllers will merge all apis under them to a single grouping ```@Api(tags = {"GroupingName"}``` – Akshay May 23 '22 at 14:19

Shane Park · Answer 3 · 2022-04-28T13:40:42.243

3

on springfox v3.0 tried almost every annotations and finally
@ApiIgnore annotation works.
Don't know why @Api(hidden=true) doesn't work.

import springfox.documentation.annotations.ApiIgnore;
@ApiIgnore
@Responsebody
public Object ...{}

edited Apr 28 '22 at 13:40

answered Mar 16 '22 at 05:15

Shane Park

81
4

score 0 · Answer 4 · answered Aug 06 '20 at 07:33

I expected the hidden attribute will work but it doesn't. I also tried to set description and also doesn't work.

Another solution is to use the tag in the @Api can help you temporarily hide this rest-controllers list and categorize your APIs in different tags.

score 0 · Answer 5 · answered Feb 21 '23 at 05:45

0

Set the attribute at controller level [ApiExplorerSettings(IgnoreApi = true)]

To hide the property just use [JsonIgnore] i.e., namespace system.text.json.serialization

answered Feb 21 '23 at 05:45

Maulik Boghara

129
1
5

score 0 · Answer 6 · answered Jul 31 '23 at 14:16

0

If you are using the OpenAPI @ApiIgnore and @Api annotations may not work.

Use @Hidden annotation on the controller you want swagger-ui to ignore/exclude and thank me later.

Happy coding :)

answered Jul 31 '23 at 14:16

Christian Oliver

112
6

user13058427 · Answer 7 · 2020-03-13T17:43:33.100

-2

springfox api version 2.9.2

works with the below example by adding on a controller class

@Api(value = "Test API Controller", tags = {"test-api-controller"}, description = "Testing API")

edited Mar 13 '20 at 17:43

answered Mar 13 '20 at 17:35

user13058427

1
1

2

Someone already made the same answer: https://stackoverflow.com/a/50739276/5022959 Please don't answer on a closed question with the same answer as the accepted answer. – Nicola Uetz Mar 13 '20 at 17:48

How to remove controller list from Swagger UI

7 Answers7

Linked