Swagger 如何表示禁止在招摇过市文档中使用数字?
我试图在我的swagger文档中指定一个名为Swagger 如何表示禁止在招摇过市文档中使用数字?,swagger,openapi,Swagger,Openapi,我试图在我的swagger文档中指定一个名为myNumber的属性,该属性可以是[-1,10]中除0以外的任何整数。这就是我到目前为止所做的: myNumber: type: integer description: You can use any number in [-1, 10] except 0. minimum: -1 maximum: 10 如何明确禁止0?我还没有在openAPI文档中找到这方面的任何规范。这可能吗?选项1:枚举 如果可能值的列表很
myNumber
的属性,该属性可以是[-1,10]中除0以外的任何整数。这就是我到目前为止所做的:
myNumber:
type: integer
description: You can use any number in [-1, 10] except 0.
minimum: -1
maximum: 10
如何明确禁止0
?我还没有在openAPI文档中找到这方面的任何规范。这可能吗?选项1:枚举
如果可能值的列表很小,则可以在枚举中列出所有值:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
枚举:[-1,1,2,3,4,5,6,7,8,9,10]
这是最简单的解决方案,可在OpenAPI 2.0和3.0中使用
备选案文2:其中之一
在OpenAPI 3.0中,您可以使用oneOf
定义两个可能值的范围:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
其中一项:
-枚举:[-1]#`最小值:-1`+`最大值:-1的简写形式`
-最低限额:1
最多:10
选择3:不
OpenAPI 3.0还支持not
来定义实例不能满足的条件。例如,排除值0,如下所示:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
最低:-1
最多:10
不是:
枚举:[0]
但是,not
的实际工具支持可能会有所不同。选项1:enum
如果可能值的列表很小,则可以在枚举中列出所有值:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
枚举:[-1,1,2,3,4,5,6,7,8,9,10]
这是最简单的解决方案,可在OpenAPI 2.0和3.0中使用
备选案文2:其中之一
在OpenAPI 3.0中,您可以使用oneOf
定义两个可能值的范围:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
其中一项:
-枚举:[-1]#`最小值:-1`+`最大值:-1的简写形式`
-最低限额:1
最多:10
选择3:不
OpenAPI 3.0还支持not
来定义实例不能满足的条件。例如,排除值0,如下所示:
myNumber:
类型:整数
说明:您可以使用[-1,10]中除0以外的任何数字。
最低:-1
最多:10
不是:
枚举:[0]
但是,对not
的实际工具支持可能会有所不同。相关:相关:只是好奇:假设在swagger 2.0中范围可以有一个较高的上限,例如10000,有没有办法做到这一点?而不是enum
-否。只是好奇:有没有办法做到这一点,假设范围可以有一个较高的上限,例如10000,在swagger 2.0中?除了enum
-否。