java - 如何使用 Springdoc 从 OpenAPI 文档中隐藏端点
问题描述
Springdoc 自动为所有处理程序方法生成 API 文档。即使没有 OpenAPI 注释。
如何从 API 文档中隐藏端点?
解决方案
@io.swagger.v3.oas.annotations.Hidden
注释可用于控制器的方法或类级别以隐藏一个或所有端点。
(参见:https ://springdoc.org/faq.html#how-can-i-hide-an-operation-or-a-controller-from-documentation )
例子:
@Hidden // Hide all endpoints
@RestController
@RequestMapping(path = "/test")
public class TestController {
private String test = "Test";
@Operation(summary = "Get test string", description = "Returns a test string", tags = { "test" })
@ApiResponses(value = { @ApiResponse(responseCode = "200", description = "Success" ) })
@GetMapping(value = "", produces = MediaType.TEXT_PLAIN_VALUE)
public @ResponseBody String getTest() {
return test;
}
@Hidden // Hide this endpoint
@PutMapping(value = "", consumes = MediaType.TEXT_PLAIN_VALUE)
@ResponseStatus(HttpStatus.OK)
public void setTest(@RequestBody String test) {
this.test = test;
}
}
编辑:
也可以只为特定包的控制器生成 API 文档。
将以下内容添加到您的application.properties
文件中:
springdoc.packagesToScan=package1, package2
(见:https ://springdoc.org/faq.html#how-can-i-explicitly-set-which-packages-to-scan )
推荐阅读
- xamarin - 在 Xamarin Forms Application 中上传文档
- java - 如何在服务器上通过 Java 运行 Powershell 命令
- bitbucket - 使用 rsync 部署 Bitbucket 管道 - 主机密钥验证失败
- c# - 如何结合将分数转换为双精度数的方法和将数字提高到另一个数字的幂的方法?
- javascript - Intersection Observer 不适用于 jQuery UI 对话框
- reactjs - 排序后组件请求数据
- javascript - 使用 Angular 7 将图像文件与其他表单数据一起提交到服务器
- amazon-dynamodb - 如何在 BatchGetItem 中使用过滤器
- c++ - 1000 个共享指针占用多少内存?
- python - 当我为每个任务有不同数量的数据样本时,是否可以制作多输入和多输出 DNN 模型