首页 API 网关 开发指南 API参考指南 API目录 API管理 ImportSwagger - 通过 Swagger 创建 API

ImportSwagger - 通过 Swagger 创建 API

通过导入符合阿里云 Swagger 规范的文本内容创建 API。

接口说明

  • 阿里云目前支持基于Swagger 2.0的扩展
  • 只支持json/yaml格式的Swagger配置文件

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apigateway:ImportSwaggerWrite
  • ApiGateway
    acs:apigateway:*:{#accountId}:*

请求参数

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

是否覆盖现有API。

覆盖检测条件为:API的HTTP请求类型+后端请求路径相同。

true
GlobalConditionobject

全局条件。

DataFormatstring

Swagger文本格式:

  • json
  • yaml
yaml
Datastring

Swagger文本内容。

"A Swagger API definition in YAML"
GroupIdstring

Swagger将被导入的分组编号

0009db9c828549768a200320714b****
DryRunboolean

预检验

true

返回参数

名称类型描述示例值
object
RequestIdstring

本次请求ID

647CEF05-404C-4125-B3D7-44792EB77392
Successarray

本次所有通过swagger导入成功的API信息

object

本次所有通过swagger导入成功的API信息

Pathstring

创建API时配置的请求路径

/http/get/mapping
HttpMethodstring

创建API时配置的http方法

get
ApiOperationstring

该API是创建(CREATE)或修改(MODIFY)

CREATE
ApiUidstring

导入成功的API的UID

8e274ec61cf6468e83b683719568****
Failedarray

本次所有通过swagger导入失败的API信息

object

本次所有通过swagger导入失败的API信息

Pathstring

创建API时配置的请求路径

/http/get/mapping
HttpMethodstring

创建API时配置的http方法

post
ErrorMsgstring

创建API时返回的错误信息

api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****
ModelFailedarray

本次所有通过 swagger 导入失败的 Model 信息。

object

本次所有通过 swagger 导入失败的 Model 信息。

ErrorMsgstring

错误信息

error msg
ModelNamestring

模型名称

Region
GroupIdstring

API 分组 ID

36d4bcfaec1946e1870d90b2d751****
ModelSuccessarray

本次所有通过 swagger 导入成功的 Model 信息。

object

本次所有通过 swagger 导入成功的 Model 信息。

ModelUidstring

模型uid

d4bcfaec1946e1870d
ModelNamestring

模型名称

NewInstance
GroupIdstring

api分组id

b2d552ed90ca435b86f7bf8d4541****
ModelOperationstring

模型操作

示例

正常返回示例

JSON格式

{
  "RequestId": "647CEF05-404C-4125-B3D7-44792EB77392",
  "Failed": {
    "ApiImportSwaggerFailed": [
      {
        "ErrorMsg": "api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb",
        "HttpMethod": "post",
        "Path": "/http/get/mapping"
      }
    ]
  },
  "Success": {
    "ApiImportSwaggerSuccess": [
      {
        "ApiOperation": "CREATE",
        "ApiUid": "8e274ec61cf6468e83b68371956831cb",
        "HttpMethod": "get",
        "Path": "/http/get/mapping"
      }
    ]
  }
}

XML格式

<ImportSwaggerResponse>
    <RequestId>647CEF05-404C-4125-B3D7-44792EB77392</RequestId>
    <Failed>
        <ApiImportSwaggerFailed>
            <ErrorMsg>api already exists : apiUid ===&gt; 8e274ec61cf6468e83b68371956831cb</ErrorMsg>
            <HttpMethod>post</HttpMethod>
            <Path>/http/get/mapping</Path>
        </ApiImportSwaggerFailed>
    </Failed>
    <Success>
        <ApiImportSwaggerSuccess>
            <ApiOperation>CREATE</ApiOperation>
            <ApiUid>8e274ec61cf6468e83b68371956831cb</ApiUid>
            <HttpMethod>get</HttpMethod>
            <Path>/http/get/mapping</Path>
        </ApiImportSwaggerSuccess>
    </Success>
</ImportSwaggerResponse>

错误码

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

阿里云首页 API 网关 相关技术圈