文档章节

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

程序猿DD
 程序猿DD
发布于 2018/10/21 13:36
字数 508
阅读 70
收藏 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
粉丝 399
博文 72
码字总数 95481
作品 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
3.2K
5
Swagger2介绍+与SpringMVC整合

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

吴伟祥
2018/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 实现动态生成接口文档

背景介绍 在以往的项目开发中,项目的接口文档一般以word的形式,互相传阅。但是具有以下缺点: 1.接口更新了,文档没更新 2.系统版本多,接口版本也很多,不好管理 3.测试接口时,通常会使用...

杨健-YJ
01/08
0
0

没有更多内容

加载失败,请刷新页面

加载更多

OSChina 周六乱弹 —— 舔狗是没有好下场的

Osc乱弹歌单(2019)请戳(这里) 【今日歌曲】 @我没有抓狂 :#今天听什么# #今天听这个# 分享 Nirvana 的歌曲《Smells Like Teen Spi...》 《Smells Like Teen Spi...》- Nirvana 手机党少...

小小编辑
今天
88
4
Linux Wireshark普通用户启动使用方案

当系统安装好Wireshark后请正常启动是否可以进行正常使用,如果不行请参考下列指导 向系统添加一个用户组 sudo groupadd wireshark //如提示此组存在可跳过 将指定用户添加到这个组中 sudo...

CHONGCHEN
今天
2
0
CSS 选择器参考手册

CSS 选择器参考手册 选择器 描述 [attribute] 用于选取带有指定属性的元素。 [attribute=value] 用于选取带有指定属性和值的元素。 [attribute~=value] 用于选取属性值中包含指定词汇的元素。...

Jack088
今天
2
0
数据库篇一

数据库篇 第1章 数据库介绍 1.1 数据库概述  什么是数据库(DB:DataBase) 数据库就是存储数据的仓库,其本质是一个文件系统,数据按照特定的格式将数据存储起来,用户可以对数据库中的数据...

stars永恒
今天
5
0
Intellij IDEA中设置了jsp页面,但是在访问页面时却提示404

在Intellij IDEA中设置了spring boot的jsp页面,但是在访问时,却出现404,Not Found,经过查找资料后解决,步骤如下: 在Run/Debug Configurations面板中设置该程序的Working Directory选项...

uknow8692
昨天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部