ImportSwagger - API Gateway - Alibaba Cloud Documentation Center

Creates an API by importing Swagger-compliant data.

Operation description

Alibaba Cloud supports extensions based on Swagger 2.0.
Alibaba Cloud supports Swagger configuration files in JSON and YAML formats.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
apigateway:ImportSwagger	Write	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Overwrite	boolean	Yes	Specifies whether to overwrite the existing API. APIs with the same HTTP request type and backend request path are considered the same.	true
GlobalCondition	object	No	The global conditions.	{}
DataFormat	string	Yes	The Swagger text format: json yaml	yaml
Data	string	Yes	The Swagger text content.	"A Swagger API definition in YAML"
GroupId	string	Yes	The ID of the API group to which the Swagger is imported.	0009db9c828549768a200320714b8930
DryRun	boolean	No	The pre-inspection.	true

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	647CEF05-404C-4125-B3D7-44792EB77392
Success	object []	The APIs that were created based on the Swagger-compliant data imported this time.
Path	string	The request path of the API.	/http/get/mapping
HttpMethod	string	The HTTP method of the API.	get
ApiOperation	string	Specifies that the operation is CREATE or MODIFY.	CREATE
ApiUid	string	The UID of the imported API.	8e274ec61cf6468e83b68371956831cb
Failed	object []	The APIs that failed to be created based on the Swagger-compliant data imported this time.
Path	string	The request path of the API.	/http/get/mapping
HttpMethod	string	The HTTP method of the API.	post
ErrorMsg	string	The error message returned.	api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb
ModelFailed	object []	The models that failed to be imported based on the Swagger-compliant data imported this time.
ErrorMsg	string	The error message.	error msg
ModelName	string	The name of the model.	Region
GroupId	string	The ID of the API group.	36d4bcfaec1946e1870d90b2d7519710
ModelSuccess	object []	The models that were imported based on the Swagger-compliant data imported this time.
ModelUid	string	The UID of the model.	d4bcfaec1946e1870d
ModelName	string	The name of the model.	NewInstance
GroupId	string	The ID of the API group.	b2d552ed90ca435b86f7bf8d45414793
ModelOperation	string	The model operation.

Examples

Sample success responses

JSONformat

{
  "RequestId": "647CEF05-404C-4125-B3D7-44792EB77392",
  "Success": {
    "ApiImportSwaggerSuccess": [
      {
        "Path": "/http/get/mapping",
        "HttpMethod": "get",
        "ApiOperation": "CREATE",
        "ApiUid": "8e274ec61cf6468e83b68371956831cb"
      }
    ]
  },
  "Failed": {
    "ApiImportSwaggerFailed": [
      {
        "Path": "/http/get/mapping",
        "HttpMethod": "post",
        "ErrorMsg": "api already exists : apiUid ===> 8e274ec61cf6468e83b68371956831cb"
      }
    ]
  },
  "ModelFailed": {
    "ApiImportModelFailed": [
      {
        "ErrorMsg": "error msg",
        "ModelName": "Region",
        "GroupId": "36d4bcfaec1946e1870d90b2d7519710"
      }
    ]
  },
  "ModelSuccess": {
    "ApiImportModelSuccess": [
      {
        "ModelUid": "d4bcfaec1946e1870d",
        "ModelName": "NewInstance",
        "GroupId": "b2d552ed90ca435b86f7bf8d45414793",
        "ModelOperation": ""
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history