DryRunSwagger - API Gateway - Alibaba Cloud Documentation Center

Checks the syntax before Swagger-compliant data is imported.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:DryRunSwagger	none	*ApiGroup `acs:apigateway:{#regionId}:{#accountId}:apigroup/{#GroupId}`	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	Yes	The global condition.	{}
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.	d633cf5524f841b9950e245b191bdabf

Response parameters

Parameter	Type	Description	Example
	object
GlobalCondition	string	The global condition.	{}
RequestId	string	The ID of the request.	EF924FE4-2EDD-4CD3-89EC-34E4708574E7
Success	array<object>	The APIs that are created based on the Swagger-compliant data imported this time.
ApiDryRunSwaggerSuccess	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
ApiSwagger	string	The API definition that complies with the Swagger specification.	"A Swagger API definition in YAML"
ApiOperation	string	Specifies whether the operation is CREATE or MODIFY.	CREATE
ApiUid	string	The UID of the successfully imported API.	8e274ec61cf6468e83b68371956831cb
Failed	array<object>	The APIs that failed to be created based on the Swagger-compliant data imported this time.
ApiImportSwaggerFailed	object
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 ===> 8e274ec61cf6468e83b68371956831cb
ModelFailed	array<object>	The models that failed to be imported through the Swagger-compliant data this time.
ApiImportModelFailed	object
ErrorMsg	string	The error message.	Not Found
ModelName	string	The name of the model.	Region
GroupId	string	The ID of the API group.	36d4bcfaec1946e1870d90b2d7519710
ModelSuccess	array<object>	The models that failed to be imported through the Swagger-compliant data this time.
ApiImportModelSuccess	object
ModelUid	string	The UID of the model.	ec1946e1870d90b2d7519
ModelName	string	The name of the model.	NewInstance
GroupId	string	The ID of the API group.	b2d552ed90ca435b86f7bf8d45414793
ModelOperation	string	The model operation.	CREATE

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change time	Summary of changes	Operation
2024-11-14	API Description Update	View Change Details