使用swagger，如何定义持续时间参数？

Question

在我使用的其中一个请求中，我希望某个属性为片刻持续时间。

如何在Swagger描述符中定义它？

据我了解，像

type: string
format: iso8601

会很好。但这是正确的做法吗？

编辑持续时间将使用ISO8601 durations表示。这意味着它们将采用

形式

• P1D为期一天
• P1Y2D为期一年零两天

Answer 1

我选择了以下解决方案

 warrantyDuration:
   type: string
   format: iso8601
   description: Warranty duration expressed as an iso8601 duration. Typical values are P1Y, P2Y, ...
   example: P1Y

我使用string类型作为字符串传输值，使用iso8601格式，这是日期和持续时间的父格式。