openapi - 如何在 openapi v3 中指定端点的授权是可选的？

Question

我正在尝试记录包含各种身份验证是可选的端点的现有 API。也就是说，如果用户获得授权，则返回的数据比未授权时返回的数据多。

无法在 OAspec v3 中明确找到。是否有编码技巧来定义这种情况？

我目前的解决方法是编写授权代码，但在端点的描述中写入授权是可选的。这有效并且似乎足够了。然而，我内心的纯粹主义者想知道是否还有另一种方式。

Answer 1

为了使安全成为可选，添加一个空的需求 {}到 security大批:

security:
  - {}   # <----
  - api_key: []

这意味着可以在有或没有安全性的情况下调用端点。

来源: this comment在 OpenAPI 规范存储库中。