OpenAPI 仅获取一条路径的文档？

Question

我正在使用 OpenAPI 来记录 Microprofile 应用程序。由于 Endpoint 包含大量方法，我想知道是否可以通过 /openapi REST 进行过滤，以便它 returns 只是一个特定的路径，例如“/users”。谢谢

Answer 1

您可以选择多个路径。在 openapi 文件中，整个 path 部分 被称为 "paths"（所以即使名称是复数）。如果您不确定如何使用它，请浏览 Swagger 门户 "search" 部分中的 openapi（您需要为此登录）。

示例：

paths: 
  /{users}:
    options:
      security:
      summary: "Temp summary"
      description: "Temp description"
      tags: 
        - "TAG"
      parameters:
..
  /test/{table}:
    options:
      security:
      summary: "Temp summary"
      description: "Temp description"
      tags: 
        - "TAG"
      parameters:
..
  /test2/user/{id}:
    options:
      security:
      summary: "Temp summary"
      description: "Temp description"
      tags: 
        - "TAG"
      parameters:

Answer 2

根据我们的用例，我们发现这是可行的。

使用 @Operation 注释您的端点并向注释添加 hidden = true 参数。

在 Kotlin 中：

    @GET @Path("/{id}")
    @Operation(
        summary = "your summary",
        hidden = true
    )
    fun getDataset(@RestPath id: String): Response {
        ....
    }

OpenAPI 仅获取一条路径的文档？

OpenAPI get Documentation only for one Path?

openapi

microprofile