DryRunSwagger - 预检查swagger

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

调试

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

调试

授权信息

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

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

请求参数

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

是否覆盖现有API。

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

true
GlobalConditionobject

全局条件。

DataFormatstring

Swagger文本格式:

  • json
  • yaml
yaml
Datastring

Swagger文本内容。

"A Swagger API definition in YAML"
GroupIdstring

指定要操作API所属分组ID

d633cf5524f841b9950e245b191bdabf

返回参数

名称类型描述示例值
object
GlobalConditionstring

全局条件。

{}
RequestIdstring

本次请求的ID。

EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Successarray

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

object

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

Pathstring

创建API时配置的请求路径

/http/get/mapping
HttpMethodstring

创建API时配置的http方法

get
ApiSwaggerstring

API 的 Swagger 定义

ApiOperationstring

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

CREATE
ApiUidstring

导入成功的API的UID

8e274ec61cf6468e83b68371956831cb
Failedarray

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

object
Pathstring

创建API时配置的请求路径

/http/get/mapping
HttpMethodstring

创建API时配置的http方法

post
ErrorMsgstring

创建API时返回的错误信息

api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb
ModelFailedarray

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

object
ErrorMsgstring

错误信息

Not Found
ModelNamestring

模型名字

Region
GroupIdstring

API 分组 ID

36d4bcfaec1946e1870d90b2d7519710
ModelSuccessarray

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

object
ModelUidstring

模型uid

ec1946e1870d90b2d7519
ModelNamestring

模型名称

NewInstance
GroupIdstring

api分组id

b2d552ed90ca435b86f7bf8d45414793
ModelOperationstring

错误码

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

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