表示数字的字符串object属性应该是字符串还是数字

Question

如标题所述，我的团队总是发送一个响应，说明哪些属性将 float/int/bigInteger 表示为字符串，这些属性的 swagger 类型应该是数字还是字符串？

Answer 1

OpenAPI 定义中的数据类型必须指明负载中使用的实际数据类型。

如果响应是

{
  "id": "12345"
}

那么id就是一个type: string属性.

您可以使用 format 和 pattern（正则表达式模式）来阐明值格式。例如，如果 id 字符串包含非负整数，则可以将 id 定义为：

type: string
pattern: "^\d+$"

Should string object property representing a number be a string or number