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.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

apigateway:ImportSwagger

create

*ApiGroup

acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}

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.	0009db9c828549768a200320714b****
DryRun	boolean	No	The pre-inspection.	true

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request.	647CEF05-404C-4125-B3D7-44792EB77392
Success	object
ApiImportSwaggerSuccess	array<object>	The APIs that are created based on the Swagger-compliant data imported this time.
	object	The APIs that are created based on the Swagger-compliant data imported this time.
Path	string	The request path configured when the API is created.	/http/get/mapping
HttpMethod	string	The HTTP method configured when the API is created.	get
ApiOperation	string	Specifies whether the operation is CREATE or MODIFY.	CREATE
ApiUid	string	The UID of the successfully imported API.	8e274ec61cf6468e83b683719568****
Failed	object
ApiImportSwaggerFailed	array<object>	The APIs that failed to be created based on the Swagger-compliant data imported this time.
	object	The APIs that failed to be created based on the Swagger-compliant data imported this time.
Path	string	The request path configured when the API is created.	/http/get/mapping
HttpMethod	string	The HTTP method configured when the API is created.	post
ErrorMsg	string	The error message returned when the API is created.	api already exists : apiUid ===> 8e274ec61cf6468e83b683719568****
ModelFailed	object
ApiImportModelFailed	array<object>	The models that failed to be imported through the Swagger-compliant data this time.
	object	The models that failed to be imported through the Swagger-compliant data 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.	36d4bcfaec1946e1870d90b2d751****
ModelSuccess	object
ApiImportModelSuccess	array<object>	The models that were imported through the Swagger-compliant data this time.
	object	The models that were imported through the Swagger-compliant data 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.	b2d552ed90ca435b86f7bf8d4541****
ModelOperation	string	The model operation	CREATE

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.