V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
V2EX 提问指南
ingin
V2EX  ›  问与答

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

  •  
  •   ingin · 2021-03-26 14:47:55 +08:00 · 820 次点击
    这是一个创建于 1322 天前的主题,其中的信息可能已经有所发展或是发生改变。
    @ApiModelProperty(value = "指标 uid")
    @NotNull(message = "指标 uid 必传")
    private String indicatorUid;
    

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

    4 条回复    2021-03-27 13:31:20 +08:00
    hronro
        1
    hronro  
       2021-03-26 15:30:47 +08:00
    当然可以做到,Swagger 这边的 API 基本和 JSON Schema 是一致的,JSON Schema 里面能做的校验在 Swagger 里面都可以做到
    uselessVisitor
        2
    uselessVisitor  
       2021-03-26 17:14:38 +08:00
    必传有 required = true
    uselessVisitor
        3
    uselessVisitor  
       2021-03-26 17:19:08 +08:00
    Valid
        4
    Valid  
       2021-03-27 13:31:20 +08:00
    为啥 @我
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5533 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 24ms · UTC 01:41 · PVG 09:41 · LAX 17:41 · JFK 20:41
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.