- 使用指南guide
- 数据结构
- 产品信息ProductInfo
- 单个 API 开放元数据Api
- 指定产品及版本的开放元数据ApiDocs
- API 概要信息ApiInfo
- 数据结构等信息Components
- 目录结构Directory
- 错误码ErrorCode
- 产品及版本的概要信息Info
- 入参Parameter
- 出参Response
- 数据结构Schema
- 协议SchemesList
- 鉴权SecurityRequirement
- API 列表
数据结构 - ApiDocs
指定产品及版本的开放元数据
| 字段名称 | 字段详情 |
|---|---|
目录 | |
目录结构。Directory 取值为对象时，代表目录节点的信息；Directory 也可能取值为字符串，代表 API 名称。 | |
idinteger<int32> | ID |
titlestring | 目录标题 |
typestring | 类型 |
子集 | |
产品及版本的概要信息 | |
stylestring | 风格 |
versionstring | 日期版本 |
productstring | 产品 |
versionstring | 开放元数据版本 |
API 概要信息集。Map 结构，Key 为 API 名称，值为 API 概要信息。 | |
单个 API 开放元数据 | |
summarystring | 概要 |
descriptionstring | 描述 |
pathstring | 路径 |
methodsarray<string> | 请求方法 |
string | |
鉴权 | |
deprecatedboolean | deprecated |
staticInfoobject | 静态信息 |
noSubstitutionReasonstring | 无替换 API 原因 |
substitutionsarray<string> | 替换 API 子级条数 <= 3 |
string | deprecated API 的替换 API，格式为：[popcode]::[version]::[api] |
returnTypestring | 返回方式。标记为异步的该异步信息将被 Terraform 使用，且将通过 API 文档透出，并对外部开发者可见。 |
callbackstring | 异步结果轮询 API。格式为：[popcode]::[version]::[api] |
callbackIntervalnumber<int32> | 轮询间隔时间(ms) |
maxCallbackTimesnumber<int32> | 轮询最大次数 |
operationTypestring | 操作类型 |
consumesarray<string> | 请求的 MIME 类型列表 |
string | 示例值:application/json |
producesarray<string> | 响应的 MIME 类型列表 |
string | 示例值:application/json |
tagsarray<string> | 标签 |
string | |
入参 | |
响应参数 | |
错误码 | |
array<ErrorCode> | 错误码列表 |
extobject | ext |
数据结构等信息 | |
schemas | |
tagsobject | 标签 |
examplesobject | 示例 |
securitySchemesobject | securitySchemes |