文档章节

Swagger中配置了@ApiModelProperty的allowableValues属性但不显示的问题

程序猿DD
 程序猿DD
发布于 10/21 13:36
字数 508
阅读 23
收藏 0

现在用Swagger来生成API文档的例子已经非常多了,今天碰到开发同事问了一个问题,帮着看了一下,主要还是配置方法的问题,所以记录一下。如果您也碰到了同样的问题,希望本文对您有用。

问题描述

@ApiModelProperty注解是用来给属性标注说明、默认值、是否可以为空等配置使用的,其中有一个属性allowableValues是本文要讲的重点,从属性命名上就能知道,该属性用来配置所标注字段允许的可选值。

但是这个属性是一个String类型,我们要如何配置可选值呢?

我们可以通过源码的注释了解到一切:

public [@interface](https://my.oschina.net/u/996807) ApiModelProperty {

    /**
     * Limits the acceptable values for this parameter.
     * <p>
     * There are three ways to describe the allowable values:
     * <ol>
     * <li>To set a list of values, provide a comma-separated list.
     * For example: {[@code](https://my.oschina.net/codeo) first, second, third}.</li>
     * <li>To set a range of values, start the value with "range", and surrounding by square
     * brackets include the minimum and maximum values, or round brackets for exclusive minimum and maximum values.
     * For example: {[@code](https://my.oschina.net/codeo) range[1, 5]}, {[@code](https://my.oschina.net/codeo) range(1, 5)}, {@code range[1, 5)}.</li>
     * <li>To set a minimum/maximum value, use the same format for range but use "infinity"
     * or "-infinity" as the second value. For example, {@code range[1, infinity]} means the
     * minimum allowable value of this parameter is 1.</li>
     * </ol>
     */
    String allowableValues() default "";

    ...
}

我们只需要通过,分割来定义可选值,或者用range函数定义范围等方式就能正确显示了,比如:

public class Filter {

    @ApiModelProperty(allowableValues = "range[1,5]")
    Integer order
    @ApiModelProperty(allowableValues = "111, 222")
    String code;

}

再运行下程序,就能看到如下内容,设置的允许值正常显示了。 pasted-123.png

© 著作权归作者所有

共有 人打赏支持
程序猿DD
粉丝 351
博文 61
码字总数 81503
作品 4
闵行
私信 提问
swagger注解类使用说明

讲解内容 swagger常用到的注解的解释 SpringMvc中控制层类中使用这些注解 swagger常用到的注解的解释 在pom.xml文件中添加包依赖:swagger-annotations-1.5.10.jar 所有注解: 常用到的注解有...

zzuqiang
2016/11/24
1K
0
Springfox 2.5.0 发布

Springfox 2.5.0 发布了,Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现。 改进日志如下: 新特性: (#1296) Support for ...

淡漠悠然
2016/06/08
3K
5
Swagger2介绍+与SpringMVC整合

前言 本文简单介绍了SpringMVC项目中集成swagger的流程和一些注意点。如果想深入分析项目源码,了解更多内容,见参考资料。 What Is Swagger? Swagger是一套围绕OpenAPI规范构建的开源工具,...

吴伟祥
07/27
0
0
Springfox 2.6.0 发布,开源的 API doc 框架

Springfox 2.6.0 发布了,Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现。 改进内容: (#1498) Add pathsGroupedBy configu...

淡漠悠然
2016/10/09
3K
10
Spring Boot(九)Swagger2自动生成接口文档和Mock模拟数据

一、简介 在当下这个前后端分离的技术趋势下,前端工程师过度依赖后端工程师的接口和数据,给开发带来了两大问题: 问题一、后端接口查看难:要怎么调用?参数怎么传递?有几个参数?参数都代...

王磊的博客
10/24
0
0

没有更多内容

加载失败,请刷新页面

加载更多

短视频App开发:短视频爆发式增长

短视频领域依旧热闹非凡,众多巨头纷纷布局短视频领域,推动市场格局的新变化。迹象显示,行业企业正纷纷瞄准AI(人工智能)及5G契机进行布局,力图获得下一步发展优势。 短视频市场火爆 竞争...

ThinkSNS账号
21分钟前
0
0
图形用户界面和交互输入方法---交互式构图技术

基本的定位方法 拖拽 约束 网格 橡皮条方法

中国龙-扬科
29分钟前
0
0
Win10:键盘任一键实现了 “一键开机”

微软自 Windows 10 系统起,默认自己的系统都开始支持“快速开启”。实质上就是“快速开机”的功能。 此功能的特点是:对于装载了 Windows 10 的电脑,开机时,只需要轻轻按一下键盘上的任意...

LivingInFHL
46分钟前
0
0
vue-router的HTML5 History 模式设置

VUE是当下最火爆的前端框架之一,vue-router是vue项目中几乎都会用到的组件,然而体验一时爽,其实坑不少。本篇经验将详细介绍vue-router的两种mode效果和开发测试环境下的问题,并给出解决方...

peakedness丶
50分钟前
1
0
Dubbo 源码分析 - 服务引用

1. 简介 在上一篇文章中,我详细的分析了服务导出的原理。本篇文章我们趁热打铁,继续分析服务引用的原理。在 Dubbo 中,我们可以通过两种方式引用远程服务。第一种是使用服务直联的方式引用...

小刀爱编程
今天
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部