使用swagger导入swagger之前先预先检查swagger的语法是否规范。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| apigateway:DryRunSwagger | Write |
|
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Overwrite | boolean | 是 | 是否覆盖现有 API。 覆盖检测条件为：API 的 HTTP 请求类型+后端请求路径相同。 | true |
| GlobalCondition | object | 是 | 全局条件。 | {} |
| DataFormat | string | 是 | Swagger 文本格式：
| yaml |
| Data | string | 是 | Swagger 文本内容。 | "A Swagger API definition in YAML" |
| GroupId | string | 是 | 指定要操作 API 所属分组 ID | d633cf5524f841b9950e245b191bdabf |
返回参数
示例
正常返回示例
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"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|
暂无变更历史