主页 / coding / 问题 / 79141196
Accepted
gstackoverflow
Asked: 2024-10-30 20:54:28 +0800 CST

如何从 API 生成中排除特定端点

  • 772

我已阅读主题 从 API 仅生成一个特定端点

但我有一个稍微不同的任务，我想从生成中排除一些特定的端点。为什么我需要它？我们有一个实验，分析人员编写开放的 API 模式，如果他们将新端点添加到现有控制器，则会导致编译错误（需要在接口中实现新方法）。我们希望在不实现存根的情况下避免此错误。

有没有什么办法可以实现它？

我很欣赏 gradle 的示例（build.gradle.kts）

spring-boot

1 个回答

  1. Best Answer

    因此，根据文档，您只需将其添加x-internal:true到 api 路径定义中，它将在生成过程中被跳过。
    例如，尝试一下：

    openapi: "3.0.0"
info:
  version: 1.0.0
  title: Swagger Petstore
  license:
    name: MIT
paths:
  /pets:
    get:
      # It will be generated
      summary: List all pets
      operationId: listPets
      ...
    post:
      # it will not
      x-internal: true
      summary: Create a pet
      operationId: createPets
      ...
components:
  schemas:
   ...

    只需让您的分析师在 api 处于阶段时默认添加此功能draft。

    • 1

相关问题