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

时间:2018-05-08 08:52:52

标签: java swagger-ui

我使用的是随Swagger UI 3.7.0一起提供的springfox-swagger-ui 2.8.0。

我想摆脱api文档页面前面的控制器列表,对我来说没用(每个标签都是空的)。

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

基本上,我想删除它:

Controller list to remove/hide

同时保持这一点:

REST api docs to keep

我通过在线文档,GitHub问题,StackOverflow问题,谷歌......一无所获。我是唯一有这个要求的人吗?

4 个答案:

答案 0 :(得分:3)

将属性说明添加到@Api

例如:

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

答案 1 :(得分:1)

在控制器上尝试此属性

[ApiExplorerSettings(IgnoreApi = true)]

答案 2 :(得分:0)

我希望hidden属性会起作用,但不会起作用。我也尝试设置description,但也不起作用。

另一种解决方案是使用@Api中的tag可以帮助您暂时隐藏此rest-controllers列表,并将API分类在不同的标签中。

答案 3 :(得分:-1)

springfox api版本2.9.2

通过添加控制器类来与以下示例配合使用

@Api(值=“测试API控制器”,标记= {“ test-api-controller”},描述=“测试API”)