如何在swagger规范中表示十进制浮点？

Question

我想在我的api文档中用小写字母表示带有2个位置的十进制数和带有1个位置的小数。我正在使用swagger 2.0，在规格中是否有内置定义类型或任何其他'round'参数，或者我唯一的选择是使用'x-'扩展名？

Answer 1

OpenAPI（fka Swagger）规范使用JSON Schema的子集来描述数据类型。

如果参数作为数字传递，您可以尝试使用this Q&A中建议的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针对浮点数的验证可能因floating-point math specifics而不可靠。

如果您的号码作为字符串传递，则可以为所需的数字格式指定正则表达式pattern：

type: string
pattern: your_regex

在任何情况下，您还可以在description。

中口头记录任何限制