Compute
Elastic Cloud Server
Huawei Cloud Flexus
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Cloud Phone Host
Huawei Cloud EulerOS
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
VPC Endpoint
Cloud Connect
Enterprise Router
Enterprise Switch
Global Accelerator
Management & Governance
Cloud Eye
Identity and Access Management
Cloud Trace Service
Resource Formation Service
Tag Management Service
Log Tank Service
Config
OneAccess
Resource Access Manager
Simple Message Notification
Application Performance Management
Application Operations Management
Organizations
Optimization Advisor
IAM Identity Center
Cloud Operations Center
Resource Governance Center
Migration
Server Migration Service
Object Storage Migration Service
Cloud Data Migration
Migration Center
Cloud Ecosystem
KooGallery
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP Filing
Support Plans
My Credentials
Customer Operation Capabilities
Partner Support Plans
Professional Services
Analytics
MapReduce Service
Data Lake Insight
CloudTable Service
Cloud Search Service
Data Lake Visualization
Data Ingestion Service
GaussDB(DWS)
DataArts Studio
Data Lake Factory
DataArts Lake Formation
IoT
IoT Device Access
Others
Product Pricing Details
System Permissions
Console Quick Start
Common FAQs
Instructions for Associating with a HUAWEI CLOUD Partner
Message Center
Security & Compliance
Security Technologies and Applications
Web Application Firewall
Host Security Service
Cloud Firewall
SecMaster
Anti-DDoS Service
Data Encryption Workshop
Database Security Service
Cloud Bastion Host
Data Security Center
Cloud Certificate Manager
Edge Security
Managed Threat Detection
Blockchain
Blockchain Service
Web3 Node Engine Service
Media Services
Media Processing Center
Video On Demand
Live
SparkRTC
MetaStudio
Storage
Object Storage Service
Elastic Volume Service
Cloud Backup and Recovery
Storage Disaster Recovery Service
Scalable File Service Turbo
Scalable File Service
Volume Backup Service
Cloud Server Backup Service
Data Express Service
Dedicated Distributed Storage Service
Containers
Cloud Container Engine
SoftWare Repository for Container
Application Service Mesh
Ubiquitous Cloud Native Service
Cloud Container Instance
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GeminiDB
GaussDB
Distributed Database Middleware
Database and Application Migration UGO
TaurusDB
Middleware
Distributed Cache Service
API Gateway
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
Multi-Site High Availability Service
EventGrid
Dedicated Cloud
Dedicated Computing Cluster
Business Applications
Workspace
ROMA Connect
Message & SMS
Domain Name Service
Edge Data Center Management
Meeting
AI
Face Recognition Service
Graph Engine Service
Content Moderation
Image Recognition
Optical Character Recognition
ModelArts
ImageSearch
Conversational Bot Service
Speech Interaction Service
Huawei HiLens
Video Intelligent Analysis Service
Developer Tools
SDK Developer Guide
API Request Signing Guide
Terraform
Koo Command Line Interface
Content Delivery & Edge Computing
Content Delivery Network
Intelligent EdgeFabric
CloudPond
Intelligent EdgeCloud
Solutions
SAP Cloud
High Performance Computing
Developer Services
ServiceStage
CodeArts
CodeArts PerfTest
CodeArts Req
CodeArts Pipeline
CodeArts Build
CodeArts Deploy
CodeArts Artifact
CodeArts TestPlan
CodeArts Check
CodeArts Repo
Cloud Application Engine
MacroVerse aPaaS
KooMessage
KooPhone
KooDrive
On this page
Help Center/ API Gateway/ User Guide/ Managing APIs/ Importing and Exporting APIs/ Restrictions and Compatibility of Importing and Exporting APIs

Restrictions and Compatibility of Importing and Exporting APIs

Updated on 2025-01-10 GMT+08:00

Note the following restrictions and compatibility issues when importing or exporting APIs on APIG:

Constraints

  • APIG parameter restrictions:
    • APIG does not support the configuration of request parameters in the formData and body locations.
    • APIG does not support the configuration of parameters consumes and produces.
    • The names of header parameters are not case-sensitive.
  • Backend policy restrictions are as follows:
    • Default backend type HTTP: The HTTP and HTTP-VPC backends are supported.
    • Default backend type HTTP-VPC: The HTTP and HTTP-VPC backends are supported.
    • Default backend type function: Only the function backend is supported.
    • Default backend type mock: Only the mock backend is supported.

Compatibility

  • OpenAPI is supported.

    The OpenAPI Specification (OAS) defines a standard, language-agnostic interface to RESTful APIs. OAS is formerly known as Swagger. APIG supports two OpenAPI specifications: Swagger 2.0 and OpenAPI 3.0. For easy understanding, in the following sections, OAS refers to OpenAPI Specification (including Swagger 2.0 and OpenAPI 3.0), Swagger refers to Swagger 2.0, and OpenAPI refers to OpenAPI 3.0.

  • Mappings between imported or exported OAS objects and APIG's objects
  • Differences in request parameter types
  • Differences in API request path template syntax
  • Extended fields supported for APIG when importing APIs
Table 1 Mappings between OAS objects and APIG's objects

Swagger Object

OpenAPI Object

(3.0.0)

APIG Object

Import

Export

info.title

info.title

API group name

Importing to a new API group: a new API group name

Importing to an existing API group: not used

An API group name consists of 3–64 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.

API group name

info.description

info.description

API group description

Importing to a new API group: description about the new group

Importing to an existing API group: not used

API group description

info.version

info.version

Version

Not used

User-defined version

The current time is used as the API group name if no name is specified.

host

server.url

API group domain name

Not used

The first user-defined domain name of an API group is preferentially used.

The independent domain name of the API group is used if the API group is not bound with any user-defined domain names.

basePath

-

-

Merged with the request path of each API

Not used

paths.path

paths.path

API request path

Merged with basePath to use as an API request path

API request path

operation.operationId

operation.operationId

API name

API name

API name

operation.description

operation.description

API description

API description

API description

operation.parameters

operation.parameters

API frontend request parameters

API request parameters

API request parameters

operation.schemes

-

API frontend request protocol

API request protocol

API request protocol

operation.responses

operation.responses

-

Not used

Default response

operation.security

operation.security

API authentication mode

API authentication mode

Used together with x-apigateway-auth-type

API authentication mode

Used together with x-apigateway-auth-type

Table 2 Differences in request parameter types

OASSwagger

APIG

Supported Attribute

integer

long

float

double

number

maximum

minimum

default

enum

required

description

string

string

maxLength

minLength

default

enum

required

description

Other

None

None

Table 3 Differences in API request path template syntax

Syntax

OASSwagger

APIG

/users/{userName}

Supported

Supported

/users/prefix-{userName}

/users/{userName}-suffix

/users/prefix-{userName} -suffix

Supported

Not supported for frontend request definition

Supported for backend request definition

/users/{proxy+}

Not supported

Supported for frontend request definition

Not supported for backend request definition

We use cookies to improve our site and your experience. By continuing to browse our site you accept our cookie policy. Find out more

Feedback

Feedback

Feedback

0/500

Selected Content

Submit selected content with the feedback