如何从 Swagger UI 中删除 controller 列表

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?

Answer 1

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") 

Answer 2

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 ...{}

Answer 3

在控制器上尝试此属性

[ApiExplorerSettings(IgnoreApi = true)]

Answer 4

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.

Answer 5

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")