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

zf2sa74q  于 2023-08-01  发布在  Java
关注(0)|答案(7)|浏览(217)

我使用的是Swagger UI 3.7.0附带的springfox-swagger-ui 2.8.0。
我想去掉API文档页面前面的控制器列表,对我来说很没用(每个标签都是空的)。
我已经尝试用@ApiIgnore注解控制器类,但当然这也删除了我需要的其余api文档。
基本上,我想删除这个:
x1c 0d1x的数据
同时保持这一点:



我通过在线文档,GitHub问题,StackOverflow问题,Google......没什么只有我有这个要求吗

bhmjp9jg

bhmjp9jg1#

在控制器上尝试此属性
第一个月

gkl3eglg

gkl3eglg2#

将属性描述添加到@Api
举例来说:

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

字符串

zfycwa2u

zfycwa2u3#

在springfox v3.0上尝试了几乎所有的注解,最后
@ApiIgnore注解有效。
不知道为什么@API(hidden=true)不起作用。

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

字符串

bd1hkmkf

bd1hkmkf4#

我希望hidden属性可以工作,但它没有。我也试过设置description,也不起作用。
另一种解决方案是使用@Api中的tag可以帮助您暂时隐藏此rest-controllers列表,并将您的API分类到不同的标签中。

xpcnnkqh

xpcnnkqh5#

在控制器级别设置属性[ApiExplorerSettings(IgnoreApi = true)]
要隐藏属性,只需使用[JsonIgnore],即名称空间system.text.json.serialization

daolsyd0

daolsyd06#

如果您使用的是OpenAPI @ApiIgnore@Api注解可能无法工作。
在你希望swagger-ui忽略/排除的控制器上使用@Hidden注解,然后再感谢我。
Happy coding:)

57hvy0tb

57hvy0tb7#

Springfox API版本2.9.2
通过在控制器类上添加
@Api(value =“测试API控制器”,tags = {“test-api-controller”},description =“测试API”)

相关问题