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

问题描述 投票:0回答:1

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

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

有办法实现吗?

我很欣赏 gradle 的示例(build.gradle.kts)

spring-boot kotlin gradle openapi openapi-generator
1个回答
0
投票

因此,根据文档,您可以简单地将

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:
   ...
© www.soinside.com 2019 - 2024. All rights reserved.