对OpenAPI使用`default`和`required`参数

时间:2018-03-30 07:37:23

标签: openapi

documentation说:

  

defaultrequired参数或属性一起使用,例如,使用路径参数。这没有意义 - 如果需要一个值,客户端必须始终发送它,并且永远不会使用默认值。

但是,当列IS NOT NULL并且DEFAULT列不是时,这是数据库常见的习惯用法吗?

为什么OpenAPI没有意义?

1 个答案:

答案 0 :(得分:1)

考虑函数声明。考虑JavaScript字符串方法indexOf

"string".indexOf(searchValue[, fromIndex])

searchValue参数是必需的,必须始终提供。它没有默认值 - 客户端必须始终提供他们想要查找的子字符串。

fromIndex参数是可选的,默认值为0.

现在,如果所需参数searchValue具有默认值,则表示不再需要此参数!它现在是可选的,如:

"string".indexOf([searchValue[, fromIndex]])

这就是defalut值是可选参数的属性而不是required参数的原因。


OpenAPI中的参数遵循相同的原则。 default值仅用于文档目的,告诉客户端开发人员如果客户端不提供可选参数,服务器将使用什么值。