ImportSwagger - 通過 Swagger 建立 API - API Gateway

通過匯入符合阿里雲 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

*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	是	Swagger 將被匯入的分組編號	0009db9c828549768a200320714b****
DryRun	boolean	否	預檢驗	true

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	本次請求 ID	647CEF05-404C-4125-B3D7-44792EB77392
Success	object
ApiImportSwaggerSuccess	array<object>	本次所有通過 swagger 匯入成功的 API 資訊
	object	本次所有通過 swagger 匯入成功的 API 資訊
Path	string	建立 API 時配置的請求路徑	/http/get/mapping
HttpMethod	string	建立 API 時配置的 http 方法	get
ApiOperation	string	該 API 是建立（CREATE）或修改（MODIFY）	CREATE
ApiUid	string	匯入成功的 API 的 UID	8e274ec61cf6468e83b683719568****
Failed	object
ApiImportSwaggerFailed	array<object>	本次所有通過 swagger 匯入失敗的 API 資訊
	object	本次所有通過 swagger 匯入失敗的 API 資訊
Path	string	建立 API 時配置的請求路徑	/http/get/mapping
HttpMethod	string	建立 API 時配置的 http 方法	post
ErrorMsg	string	建立 API 時返回的錯誤資訊	api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****
ModelFailed	object
ApiImportModelFailed	array<object>	本次所有通過 swagger 匯入失敗的 Model 資訊。
	object	本次所有通過 swagger 匯入失敗的 Model 資訊。
ErrorMsg	string	錯誤資訊	error msg
ModelName	string	模型名稱	Region
GroupId	string	API 分組 ID	36d4bcfaec1946e1870d90b2d751****
ModelSuccess	object
ApiImportModelSuccess	array<object>	本次所有通過 swagger 匯入成功的 Model 資訊。
	object	本次所有通過 swagger 匯入成功的 Model 資訊。
ModelUid	string	模型 uid	d4bcfaec1946e1870d
ModelName	string	模型名稱	NewInstance
GroupId	string	api 分組 id	b2d552ed90ca435b86f7bf8d4541****
ModelOperation	string	模型操作	CREATE

樣本

正常返回樣本

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"
      }
    ]
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。