如何从Swagger UI中删除控制器列表

thi*_*k01 8 java swagger-ui

我正在使用Swagger UI 3.7.0附带的springfox-swagger-ui 2.8.0。

我想摆脱api文档页面前面的控制器列表,这对我来说毫无用处(每个选项卡都是空的)。

我已经尝试使用@ApiIgnore注释控制器类,但是当然这也删除了我需要的其余api文档。

基本上,我想删除此:

要删除/隐藏的控制器列表

同时保留以下内容:

保留的REST API文档

我浏览了在线文档,GitHub问题,StackOverflow问题,Google等。我是唯一有此要求的人吗?

小智 13

在控制器上试试这个属性

[ApiExplorerSettings(IgnoreApi = true)]


小智 5

将属性描述添加到@Api

例如:

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

  • 是!您的提示使我找到了正确的解决方案:在实现类中添加@Api(tags = {“ MagazzinoPF”})。无论如何,这会将空文档行“合并”到下面的实际文档中。如果您修改答案,我会接受。谢谢! (5认同)
  • 我已经有了 description 属性(它被标记为已弃用)。删除它没有任何改变:-( (2认同)