首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >OpenAPI (Swagger)配置Quarkus

OpenAPI (Swagger)配置Quarkus
EN

Stack Overflow用户
提问于 2022-09-06 00:07:15
回答 1查看 223关注 0票数 0

晚安。我对Quarkus并不熟悉,我正在通过OpenApi配置swagger,但是我对它的配置有疑问,例如,我通过对象组合处理请求/响应,但是,如果我想隐藏一些类来完成它,并且只知道显示我想要的类,例如:

我想隐藏那些时代,CalendarDate和约会类,我如何做到这一点?

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

我尝试使用@Parameters标记将描述添加到accountNumberCustomerAccount字段,但是,它没有反映在OpenApi中模式的描述中:

代码语言:javascript
复制
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级别上,我得到了如下内容:

事先问候和感谢

EN

回答 1

Stack Overflow用户

发布于 2022-09-08 18:31:29

因此,这里有多个问题:

  1. 如何隐藏模式?这应该使用annotation.
  2. How @Schema(hidden = true)将附加信息(如描述)添加到字段中?您可以使用常规openapi @Schema注释(请参阅https://github.com/swagger-api/swagger-core/wiki/Swagger-2.X---Annotations#schema)

)。

票数 0
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/73615573

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档