ingin
V2EX  ›  问与答

swagger 文档可以显示 @valid 的规则信息吗?

  •  
  •   ingin · Mar 26, 2021 · 1611 views
    This topic created in 2053 days ago, the information mentioned may be changed or developed.
    @ApiModelProperty(value = "指标 uid")
    @NotNull(message = "指标 uid 必传")
    private String indicatorUid;
    

    此时希望 swagger 文档显示indicatorUid这个字段必传,或者如果我加了其他注解,例如 @max @min 等,希望 swagger 可以显示某个字段允许的传值规则,这个需求 swagger 可以做到吗?

    4 replies  •  2021-03-27 13:31:20 +08:00
    hronro
    hronro
    Mar 26, 2021
    1
    当然可以做到,Swagger 这边的 API 基本和 JSON Schema 是一致的,JSON Schema 里面能做的校验在 Swagger 里面都可以做到
    zm8m93Q1e5otOC69
    zm8m93Q1e5otOC69
    Mar 26, 2021
    2
    必传有 required = true
    Valid
    Valid
    Mar 27, 2021
    4
    为啥 @我
    About   ·   Help   ·   Advertise   ·   Blog   ·   API   ·   FAQ   ·   Privacy   ·   Solana   ·   1046 Online   Highest 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 38ms · UTC 00:03 · PVG 08:03 · LAX 16:03 · JFK 19:03
    ♥ Do have faith in what you're doing.