内容简介：现在用Swagger来生成API文档的例子已经非常多了，今天碰到开发同事问了一个问题，帮着看了一下，主要还是配置方法的问题，所以记录一下。如果您也碰到了同样的问题，希望本文对您有用。但是这个属性是一个String类型，我们要如何配置可选值呢？
现在用Swagger来生成API文档的例子已经非常多了，今天碰到开发同事问了一个问题，帮着看了一下，主要还是配置方法的问题，所以记录一下。如果您也碰到了同样的问题，希望本文对您有用。
问题描述
@ApiModelProperty 注解是用来给属性标注说明、默认值、是否可以为空等配置使用的，其中有一个属性 allowableValues 是本文要讲的重点，从属性命名上就能知道，该属性用来配置所标注字段允许的可选值。
但是这个属性是一个String类型，我们要如何配置可选值呢？
我们可以通过源码的注释了解到一切：
public @interface 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 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 range[1, 5]}, {@code 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;
}
再运行下程序，就能看到如下内容，设置的允许值正常显示了。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持 码农网
猜你喜欢:
- 浅谈Spring Boot 属性配置和自定义属性配置
- Hive学习之常见属性配置
- Android Studio 中配置 Java 8 属性
- Spring Cloud 覆写远端的配置属性
- Dubbo配置属性初始化详解 原 荐
- Spring Boot配置特定属性spring.profiles
本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。
并行计算导论
Ananth Grama、George Karypis、张武、毛国勇、Anshul Gupta、Vipin Kumar、程海英 / 张武、毛国勇、程海英 / 机械工业出版社 / 2005-1-1 / 49.00元
《并行计算导论》(原书第2版)全面介绍并行计算的各个方面，包括体系结构、编程范例、算法与应用和标准等，涉及并行计算的新技术，也覆盖了较传统的算法，如排序、搜索、图和动态编程等。《并行计算导论》(原书第2版)尽可能采用与底层平台无关的体系结构并且针对抽象模型来设计处落地。书中选择MPI、POSIX线程和OpenMP作为编程模型，并在不同例子中反映了并行计算的不断变化的应用组合。一起来看看 《并行计算导论》 这本书的介绍吧!
