ImportOAS
使用标准OAS定义导入API
服务地址:
华东1 金融云
输入参数
只看必填
GroupIdAPI分组的ID
DataOAS文本内容
Overwrite是否覆盖现有API
请选择布尔值
IgnoreWarning忽略警告信息
请选择布尔值
SkipDryRun跳过预检查
请选择布尔值
OASVersionOAS版本信息
BackendName后端服务名称
AuthTypeAPI安全认证类型
RequestMode入参请求的模式
插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

请求参数

字段名称字段详情
GroupIdstring

API 分组的 ID

示例值:08ae4aa0f95e4321849ee57f4e0b3077参考取值来源:
    ModifyApiGroup
    CreateApiGroup
    DescribeApiGroups
Datastring

OAS 文本内容,或 OSS 链接

示例值:swagger: "2.0" info: version: "1.0.0" title: "Swagger Petstore 2.0" basePath: "/" schemes: - "https" - "http" paths: /pet/findByStatus: get: tags: - "pet" summary: "Finds Pets by status" operationId: "findPetsByStatus" parameters: - name: "status" in: "query" required: true type: "array" items: type: "string" enum: - "available" - "pending" - "sold" default: "available" collectionFormat: "multi" responses: "200": description: "successful operation" schema: type: "array" items: $ref: "#/definitions/Pet" "400": description: "Invalid status value" definitions: Category: type: "object" properties: id: type: "integer" format: "int64" name: type: "string" Tag: type: "object" properties: id: type: "integer" format: "int64" name: type: "string" Pet: type: "object" required: - "name" - "photoUrls" properties: id: type: "integer" format: "int64" category: $ref: "#/definitions/Category" name: type: "string" example: "doggie" photoUrls: type: "array" items: type: "string" tags: type: "array" items: $ref: "#/definitions/Tag" status: type: "string" description: "pet status in the store" enum: - "available" - "pending" - "sold"参考取值来源:
    CreateDataset
Overwriteboolean

是否覆盖现有 API。展开详情

示例值:true
IgnoreWarningboolean

忽略警告信息

示例值:true
SkipDryRunboolean

跳过预检查,进行导入

示例值:true
OASVersionstring

OAS 版本信息

示例值:OAS2
BackendNamestring

后端服务名称

示例值:testBackendService参考取值来源:
    CreateBackend
    DescribeBackendInfo
AuthTypestring

API 安全认证类型,目前可以取值:展开详情

示例值:APP
RequestModestring

入参请求的模式,取值为:展开详情

示例值:PASSTHROUGH

返回参数

字段名称字段详情
OperationIdstring

进行导入操作时生成的异步任务 ID,用来查询导入任务的执行情况

示例值:c16a1880f5164d779f6a54f64d997cd9
RequestIdstring

请求 ID

示例值:E7FE7172-AA75-5880-B6F7-C00893E9BC06
ErrorMessagesobject
WarningMessagesobject
SuccessApisobject
FailedApisobject
FailedModelsobject
SuccessModelsobject
变更历史
变更时间变更内容概要操作
2022-11-16
删除请求参数DryRun
2022-11-16
新增OpenAPI,通过OAS导入API