如何从 Swagger 中删除控制器列表 UI
How to remove controller list from Swagger UI
我正在使用随 Swagger UI 3.7.0.
一起提供的 springfox-swagger-ui 2.8.0
我想摆脱 api 文档页面前面的控制器列表,这对我来说毫无用处(每个选项卡都是空的)。
我已经尝试用@ApiIgnore 注释控制器 class,但是当然这也会删除我需要的其余 api 文档。
基本上,我想删除这个:
同时保持这个:
我浏览了在线文档、GitHub 问题、Whosebug 问题、Google...什么都没有。只有我有这个要求吗?
将属性描述添加到@Api
:
例如:
@Api(value = "Test API Controller", produces = MediaType.APPLICATION_JSON_VALUE, tags = {"test-api-controller"}, description = "Testing API")
在控制器上试试这个属性
[ApiExplorerSettings(IgnoreApi = true)]
springfox api 版本 2.9.2
通过添加控制器 class
与以下示例配合使用
@Api(值="Test API Controller",标签={"test-api-controller"},描述="Testing API")
我预计 hidden
属性会起作用,但它不起作用。我也试过设置 description
也没用。
另一个解决方案是使用@Api中的tag
可以帮助您暂时隐藏此rest-controllers列表并将您的API分类在不同的标签中。
在 springfox v3.0 上几乎尝试了所有注释,最后
@Api忽略注释工作。
不知道为什么 @Api(hidden=true) 不起作用。
import springfox.documentation.annotations.ApiIgnore;
@ApiIgnore
@Responsebody
public Object ...{}
我正在使用随 Swagger UI 3.7.0.
一起提供的 springfox-swagger-ui 2.8.0我想摆脱 api 文档页面前面的控制器列表,这对我来说毫无用处(每个选项卡都是空的)。
我已经尝试用@ApiIgnore 注释控制器 class,但是当然这也会删除我需要的其余 api 文档。
基本上,我想删除这个:
同时保持这个:
我浏览了在线文档、GitHub 问题、Whosebug 问题、Google...什么都没有。只有我有这个要求吗?
将属性描述添加到@Api
:
例如:
@Api(value = "Test API Controller", produces = MediaType.APPLICATION_JSON_VALUE, tags = {"test-api-controller"}, description = "Testing API")
在控制器上试试这个属性
[ApiExplorerSettings(IgnoreApi = true)]
springfox api 版本 2.9.2
通过添加控制器 class
与以下示例配合使用@Api(值="Test API Controller",标签={"test-api-controller"},描述="Testing API")
我预计 hidden
属性会起作用,但它不起作用。我也试过设置 description
也没用。
另一个解决方案是使用@Api中的tag
可以帮助您暂时隐藏此rest-controllers列表并将您的API分类在不同的标签中。
在 springfox v3.0 上几乎尝试了所有注释,最后
@Api忽略注释工作。
不知道为什么 @Api(hidden=true) 不起作用。
import springfox.documentation.annotations.ApiIgnore;
@ApiIgnore
@Responsebody
public Object ...{}