通過導入符合阿里云 Swagger 規范的文本內容創建 API。
接口說明
- 阿里云目前支持基于 Swagger 2.0 的擴展
- 只支持 json/yaml 格式的 Swagger 配置文件
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| apigateway:ImportSwagger | create |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| Overwrite | boolean | 是 | 是否覆蓋現有 API。 覆蓋檢測條件為：API 的 HTTP 請求類型+后端請求路徑相同。 | true |
| GlobalCondition | object | 否 | 全局條件。 | {} |
| DataFormat | string | 是 | Swagger 文本格式：
| yaml |
| Data | string | 是 | Swagger 文本內容。 | "A Swagger API definition in YAML" |
| GroupId | string | 是 | Swagger 將被導入的分組編號 | 0009db9c828549768a200320714b**** |
| DryRun | boolean | 否 | 預檢驗 | true |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "647CEF05-404C-4125-B3D7-44792EB77392",
"Success": {
"ApiImportSwaggerSuccess": [
{
"Path": "/http/get/mapping",
"HttpMethod": "get",
"ApiOperation": "CREATE",
"ApiUid": "8e274ec61cf6468e83b683719568****"
}
]
},
"Failed": {
"ApiImportSwaggerFailed": [
{
"Path": "/http/get/mapping",
"HttpMethod": "post",
"ErrorMsg": "api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****"
}
]
},
"ModelFailed": {
"ApiImportModelFailed": [
{
"ErrorMsg": "error msg",
"ModelName": "Region",
"GroupId": "36d4bcfaec1946e1870d90b2d751****"
}
]
},
"ModelSuccess": {
"ApiImportModelSuccess": [
{
"ModelUid": "d4bcfaec1946e1870d",
"ModelName": "NewInstance",
"GroupId": "b2d552ed90ca435b86f7bf8d4541****",
"ModelOperation": "CREATE"
}
]
}
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|
暫無變更歷史