OpenAPI（Swagger）配置Quarkus

Question

晚安。我是 Quarkus 的新手，我正在通过 OpenApi 配置 swagger，但是我对其配置存有疑问，例如我通过对象组合来处理请求/响应，但是，如果我想隐藏一些类，该怎么做？只知道显示我想要的，例如：

我想隐藏那些 Era、CalendarDate 和 Date 类，我该怎么做？

我还想向字段添加描述，在我的例子中，我只使用 post 方法，但是向字段添加描述的标签是什么？:

我尝试使用 @Parameters 标签向 accountNumberCustomerAccount 字段添加描述，但是，它没有反映在 OpenApi 中架构的描述中：

package org.tmve.subscriber.domains.request.body;

import com.fasterxml.jackson.annotation.JsonProperty;
import lombok.Data;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;

import javax.validation.constraints.NotEmpty;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.validation.constraints.Size;

@Data

@Schema(name="UpdatePrepaidSubscriberPlanBSRequest", description = "Campos de entradas para el cambio de plan")
public class UpdatePrepaidSubscriberPlanBSRequest {

    @NotNull
    @Size(min=1,max=10)
    @NotEmpty
    @Pattern(regexp="^\\d+$")
    @JsonProperty("subscriberId")
    private String subscriberId;

    @NotNull
    @NotEmpty
    @Size(min=1,max=12)
    @Parameter(description="Numero de cuenta cliente", required = true)
    private String accountNumberCustomerAccount;

    @NotNull
    @NotEmpty
    private String planCode;

    @NotNull
    @NotEmpty
    private String coverageZone;

    @NotNull
    @NotEmpty
    private String salesAgent;

}

但是，在 OpenApi 级别我得到这样的信息：

提前致以问候和感谢

Answer 1

所以，这里有多个问题：

1. 如何隐藏架构？ 这应该使用

   @Schema(hidden = true)

   注释来工作。
2. 如何向字段添加附加信息（如描述）？您可以使用常规 openapi

   @Schema

   注释（请参阅https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X ---注释#schema)

Answer 2

要从架构中禁用某些组件，请将以下行添加到 application.properties 中：

mp.openapi.scan.exclude.packages=java.util,java.time, //etc.

并使用

@Schema

为您的字段添加描述。