我想在我的 api 文档中用 2 位表示十进制,用 1 位表示十进制。我正在使用 swagger 2.0,规范中是否有内置定义的类型或任何其他"圆形"参数,或者我唯一的选择是使用"x-"扩展名?
OpenAPI (fka Swagger( 规范使用 JSON 模式的子集来描述数据类型。
如果参数作为数字传递,您可以尝试按照本问答中的建议使用multipleOf
:
type: number
multipleOf: 0.1 # up to 1 decimal place, e.g. 4.2
# multipleOf: 0.01 # up to 2 decimal places, e.g. 4.25
Hovewer,multipleOf
由于浮点数学细节,针对浮点数的验证可能不可靠。
如果您的数字作为字符串传递,则可以为所需的数字格式指定正则表达式pattern
:
type: string
pattern: your_regex
无论如何,您也可以在description
中口头记录任何限制。