如何使用 Springdoc 从 OpenAPI 文档中隐藏端点

Question

Springdoc 会自动生成所有处理程序方法的 API 文档。即使没有 OpenAPI 注释。

如何在 API 文档中隐藏端点？

Answer 1

可以在控制器的方法或类级别使用@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(

Answer 2

也可以仅为特定路径生成 API 文档。

将以下内容添加到您的应用程序.yml 文件中：

springdoc:
paths-to-match: /api/**, /v1

Answer 3

如果您正在使用 Swagger API 并且想要隐藏特定端点，请在该端点上使用@ApiOperation(value = "Get Building",hidden=true)...隐藏属性应为 true。

@RestController
@Api(tags="Building")
@RequestMapping(value="/v2/buildings")
public class BuildingsController {
@ApiOperation(value = "Get Building",hidden=true)
@GetMapping(value = "/{reference}")
public Account getBuildings(@PathVariable String reference) {
....
}