OpenAPI规范中字符串类型大数的format取值咨询

首先明确：JSON Schema官方规范里并没有定义numeric-string这个format值，所以它不属于通用做法，不同的JSON Schema验证工具大概率不会识别这个自定义的format，甚至会直接忽略它。

针对这类场景，推荐以下两种处理方式：

• 用pattern做精确约束
  这是兼容性最好、最通用的方案。通过正则表达式限定字符串必须符合数值格式，比如整数或带小数的数值，示例如下：

  properties:
    pi_to_hundred_decimals:
      type: string
      pattern: "^-?\\d+(\\.\\d+)?$"
      description: 保留百位小数的圆周率值。
  

  这个正则可以匹配正负整数、正负小数的字符串形式，所有支持JSON Schema的工具都能正确解析验证。

• 避开非标准或错误取值

  • 不要用numeric：numeric并不是JSON Schema针对string类型的合法format，它在部分扩展中可能用于描述number类型的数值约束，和string类型不匹配，使用后会导致逻辑混乱。
  • 自定义numeric-string仅限特定场景：如果你的团队或使用的验证工具支持自定义format，可临时使用，但跨工具迁移时会出现兼容性问题，不推荐作为通用方案。

内容的提问来源于stack exchange，提问作者Attila