OpenAPI 规范 v3.1.0
OpenAPI 规范 v3.1.0
1. OpenAPI 规范
2. 简介
3. 定义
4. 规范
4.1 版本
4.2 格式
4.3 文档结构
4.4 数据类型
4.5 富文本格式化
4.6 URI 中的相对引用
4.7 URL 中的相对引用
4.8 模式
4.8.1 OpenAPI 对象
4.8.2 Info 对象
4.8.3 Contact 对象
4.8.4 License 对象
4.8.5 Server 对象
4.8.6 Server Variable 对象
4.8.7 Components 对象
4.8.8 Paths 对象
4.8.9 Path Item 对象
4.8.10 Operation 对象
4.8.11 External Documentation 对象
4.8.12 Parameter 对象
4.8.13 Request Body 对象
4.8.14 Media Type 对象
4.8.15 Encoding 对象
4.8.16 Responses 对象
4.8.17 Response 对象
4.8.18 Callback 对象
4.8.19 Example 对象
4.8.20 Link 对象
4.8.21 Header 对象
4.8.22 Tag 对象
4.8.23 Reference 对象
4.8.24 Schema 对象
4.8.25 Discriminator 对象
4.8.26 XML 对象
4.8.27 Security Scheme 对象
4.8.28 OAuth Flows 对象
4.8.29 OAuth Flow 对象
4.8.30 Security Requirement 对象
4.9 规范扩展
4.10 安全过滤
4.8.30 Security Requirement 对象
创建时间: 2025-05-29 16:38
列出执行此操作所需的安全性方案。每个属性使用的名称必须对应于在安全方案下组件对象中声明的安全方案。 包含多个方案的安全需求对象要求所有方案必须满足才能授权请求。这支持需要多个查询参数或HTTP标头来传递安全信息的场景。
当在OpenAPI对象或操作对象上定义安全需求对象的列表时,列表中只需要满足其中一个安全需求对象即可授权请求。
4.8.30.1 模式化字段
字段模式 | 类型 | 描述 |
---|---|---|
{名称} | [string ] | 每个名称必须对应于在安全方案下组件对象中声明的安全方案。如果安全方案的类型为"oauth2" 或"openIdConnect" ,则该值为执行所需的一系列范围名称,如果授权不需要指定的范围,则该列表可以为空。对于其他安全方案类型,该数组可以包含执行所需的一系列角色名称,但在其他方面未定义或不在带内交换。 |
4.8.30.2 Security Requirement 对象示例
4.8.30.2.1 非 OAuth2 安全需求
{
"api_key": []
}
api_key: []
4.8.30.2.2 OAuth2 安全需求
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
petstore_auth:
- write:pets
- read:pets
4.8.30.2.3 可选 OAuth2 安全
可选的OAuth2安全,将在OpenAPI对象或操作对象中定义
{
"security": [
{},
{
"petstore_auth": [
"write:pets",
"read:pets"
]
}
]
}
security:
- {}
- petstore_auth:
- write:pets
- read:pets
最后更新: -