在导入API前使用DryRunSwagger预检查Swagger语法-API 网关-阿里云-API 网关(API Gateway)-阿里云帮助中心

使用swagger导入swagger之前先预先检查swagger的语法是否规范。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

apigateway:DryRunSwagger

none

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

无

请求参数

名称	类型	必填	描述	示例值
Overwrite	boolean	是	是否覆盖现有 API。覆盖检测条件为：API 的 HTTP 请求类型+后端请求路径相同。	true
GlobalCondition	object	否	全局条件。	{}
DataFormat	string	是	Swagger 文本格式： json yaml	yaml
Data	string	是	Swagger 文本内容。	"A Swagger API definition in YAML"
GroupId	string	是	指定要操作 API 所属分组 ID	d633cf5524f841b9950e245b191bdabf

返回参数

名称	类型	描述	示例值
	object
GlobalCondition	string	全局条件。	{}
RequestId	string	本次请求的 ID。	EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Success	object
ApiDryRunSwaggerSuccess	array<object>	本次所有通过 swagger 导入成功的 API 信息
	object	本次所有通过 swagger 导入成功的 api 信息
Path	string	创建 API 时配置的请求路径	/http/get/mapping
HttpMethod	string	创建 API 时配置的 http 方法	get
ApiSwagger	string	API 的 Swagger 定义	"A Swagger API definition in YAML"
ApiOperation	string	该 API 是创建（CREATE）或修改（MODIFY）	CREATE
ApiUid	string	导入成功的 API 的 UID	8e274ec61cf6468e83b68371956831cb
Failed	object
ApiImportSwaggerFailed	array<object>	本次所有通过 swagger 导入失败的 API 信息
	object
Path	string	创建 API 时配置的请求路径	/http/get/mapping
HttpMethod	string	创建 API 时配置的 http 方法	post
ErrorMsg	string	创建 API 时返回的错误信息	api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb
ModelFailed	object
ApiImportModelFailed	array<object>	本次所有通过 swagger 导入失败的 Model 信息。
	object
ErrorMsg	string	错误信息	Not Found
ModelName	string	模型名字	Region
GroupId	string	API 分组 ID	36d4bcfaec1946e1870d90b2d7519710
ModelSuccess	object
ApiImportModelSuccess	array<object>	本次所有通过 swagger 导入成功的 Model 信息。
	object
ModelUid	string	模型 uid	ec1946e1870d90b2d7519
ModelName	string	模型名称	NewInstance
GroupId	string	api 分组 id	b2d552ed90ca435b86f7bf8d45414793
ModelOperation	string	该模型是创建（CREATE）或修改（MODIFY）	CREATE

示例

正常返回示例

JSON格式

{
  "GlobalCondition": "{}",
  "RequestId": "EF924FE4-2EDD-4CD3-89EC-34E4708574E7",
  "Success": {
    "ApiDryRunSwaggerSuccess": [
      {
        "Path": "/http/get/mapping",
        "HttpMethod": "get",
        "ApiSwagger": "\"A Swagger API definition in YAML\"",
        "ApiOperation": "CREATE",
        "ApiUid": "8e274ec61cf6468e83b68371956831cb"
      }
    ]
  },
  "Failed": {
    "ApiImportSwaggerFailed": [
      {
        "Path": "/http/get/mapping",
        "HttpMethod": "post",
        "ErrorMsg": "api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb"
      }
    ]
  },
  "ModelFailed": {
    "ApiImportModelFailed": [
      {
        "ErrorMsg": "Not Found",
        "ModelName": "Region",
        "GroupId": "36d4bcfaec1946e1870d90b2d7519710"
      }
    ]
  },
  "ModelSuccess": {
    "ApiImportModelSuccess": [
      {
        "ModelUid": "ec1946e1870d90b2d7519",
        "ModelName": "NewInstance",
        "GroupId": "b2d552ed90ca435b86f7bf8d45414793",
        "ModelOperation": "CREATE"
      }
    ]
  }
}

错误码

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

变更历史

更多信息，参考变更详情。