Java 如何使用Springfox从Swagger文档中隐藏端点
我有一个Spring Boot项目,下一个依赖于Springfox:Java 如何使用Springfox从Swagger文档中隐藏端点,java,spring-boot,swagger-2.0,springfox,Java,Spring Boot,Swagger 2.0,Springfox,我有一个Spring Boot项目,下一个依赖于Springfox: <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> <scope>compile</scope> </dep
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
您已在界面上添加了
@apignore
注释。看起来,当添加到接口上时,此注释不起作用。(我真的不明白为什么@Api
可以在接口上工作,而@apignore
不能。还有一种方法是使用@ApiOperation(hidden=true)
这可用于控制器/处理程序级别的方法。
例如
@RestController
公共家庭控制器{
@ApiOperation(值=”,hidden=true)
公共字符串getMessage(@RequestParam(value=“msg”)最终字符串msg){
返回味精;
}
}
另一种选择是完全删除@Api,您的控制器及其方法不应该被招摇撞骗。我们只想隐藏特定方法的场景在类.For swagger.v3中,在io.swagger.core.v3:swagger annotations:2.0.10 jar
中有一个名为Hidden
的注释。要隐藏的方法可以使用Hidden
注释进行注释,如下所示。下面的方法显示了需要对swag进行隐藏的DELETE
操作的方法ger文件
@DELETE
@Hidden
public void deleteList(int id) {
//code goes here.
}
对于OpenAPI3和SpringBoot:我在控制器的方法上使用了@Hidden注释。
它似乎在方法级别和控制器级别都起作用 @隐藏批注是使用以下方法从导入的:
import io.swagger.v3.oas.annotations;
你的招摇过市摘要配置是什么样子的?我已经编辑了帖子来添加招摇过市配置。我也解决了这个操作。我的文档在一个界面中。a推荐它。
@RestController
public HomeController{
@ApiOperation(value = "<Your Message>", hidden = true)
public String getMessage(@RequestParam(value = "msg") final String msg){
return msg;
}
}
@DELETE
@Hidden
public void deleteList(int id) {
//code goes here.
}
import io.swagger.v3.oas.annotations;