跳到主要内容

Security Requirement 对象

列出执行此 operation 所需的 security schemes。每个属性的名字都必须  与 Components 对象 中 Security Schemes 声明的 security scheme 相符。

包含多个 schemes 的 Security Requirement 对象中的所有 scheme 都必须要满足授权请求。这便能够支持需要使用多个 query parameters 或 HTTP headers 来传递安全信息的情景。

当 When a list of Security Requirement Objects is defined on the Open API 对象 或 [Operation 对象] ( #operationObject) 包含一组 Security Requirement 对象时，请求只需要满足其中一个即可。

模式字段​

字段名模式类型描述
{name}[string]每个名称都必须对应于 Components 对象 下的 Security Schemes 的一个 security scheme。如果此 security scheme 是 "oauth2" 或 "openIdConnect" 类型，那么其值是用于执行的一组 scope names。对于其他 security scheme 类型。此数组必须是空的。

Security Requirement 对象示例​

Non-OAuth2 Security Requirement​

{
  "api_key": []
}
api_key: [ ]

OAuth2 Security Requirement​

{
  "petstore_auth": [
    "write:pets",
    "read:pets"
  ]
}
petstore_auth:
  - write:pets
  - read:pets