ExportOAS - 导出OAS定义

导出OAS。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
DataFormatstring

Swagger 文本格式:

  • json
  • yaml
yaml
ApiIdListarray

需要导出的 API 列表

string

API ID

8afff6c8c4c6447abb035812e4d66xxx
GroupIdstring

API 分组 ID

42925e7f5209438186d5560239af5xxx
StageNamestring

API 已发布的环境:

  • RELEASE:线上
  • PRE:预发
  • TEST:测试
RELEASE
OasVersionstring

OAS 版本号:

  • oas2
  • oas3
oas2
WithXExtensionsboolean

是否导出 API 网关拓展定义

true
PageNumberinteger

导出分组下所有 API 时的分页页码

1

返回参数

名称类型描述示例值
object
Datastring

Swagger 文件经 base64 编码后的数据,通过 base64 解码可以得到文件

UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...
RequestIdstring

请求 ID

CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx

示例

正常返回示例

JSON格式

{
  "Data": "UEsDBBQACAAIAABc8FgAAAAAAAAAAAAAAAA...",
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876xxxxxxxx"
}

错误码

访问错误中心查看更多错误码。