swagger - 在 OpenAPI/Swagger 文件中声明日期的正确方法是什么？

Question

在 swagger-file 对象中声明日期的正确方法是什么？我认为是:

  startDate:
    type: string
    description: Start date
    example: "2017-01-01"
    format: date

但我看到很多这样的声明:

  startDate:
    type: string
    description: Start date
    example: "2017-01-01"
    format: date
    pattern: "YYYY-MM-DD"
    minLength: 0
    maxLength: 10

谢谢。

Answer 1

OpenAPI Specification说你必须使用:
类型:字符串
格式:日期 # 或日期时间
支持的模式在 RFC 3339, section 5.6 中定义。 (实际上是 ISO 8601)和示例在第 5.8 节中提供。所以对于 date值应类似于“2018-03-20”和 date-time ，“2018-03-20T09:12:28Z”。因此，当使用 date或 date-time , pattern是不必要的，实际上应该省略。
如果您需要支持格式与 RFC 3339 不同的日期/时间，您是 不是 允许将您的参数指定为format: date或 format: date-time .相反，您应该指定 format: string使用适当的 pattern .
最后，请注意 pattern的 "YYYY-MM-DD"根据规范无效:pattern必须是 正则表达式 ，而不是占位符或格式字符串。
如果您违反上述任何规则来解决从 OpenAPI 规范生成 UI 的工具中的错误，您应该强烈考虑使用该工具提出这些错误，而不是生成无效的 OpenAPI 规范来解决此问题。