swagger - 如何在 swagger 规范中表示十进制 float ？

Question

我想在我的 api 文档中用 2 位表示小数，用 1 位表示小数。我正在使用 swagger 2.0，规范中是否有内置定义的类型或任何其他“圆形”参数，或者我唯一的选择是使用“x-”扩展名？

Answer 1

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

如果参数以数字形式传递，您可以尝试使用 multipleOf正如 this Q&A 中所建议的:

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

霍威， multipleOf由于 floating-point math specifics，对浮点数的验证可能不可靠.

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

type: string
pattern: your_regex

无论如何，您还可以在 description 中口头记录任何限制。 .