计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
弹性伸缩 AS
镜像服务 IMS
专属主机 DeH
函数工作流 FunctionGraph
云手机服务器 CPH
Huawei Cloud EulerOS
网络
虚拟私有云 VPC
弹性公网IP EIP
虚拟专用网络 VPN
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
VPC终端节点 VPCEP
云连接 CC
企业路由器 ER
企业交换机 ESW
全球加速 GA
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
边缘安全 EdgeSec
威胁检测服务 MTD
CDN与智能边缘
内容分发网络 CDN
CloudPond云服务
智能边缘云 IEC
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
云搜索服务 CSS
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
数据可视化 DLV
数据湖工厂 DLF
湖仓构建 LakeFormation
企业应用
云桌面 Workspace
应用与数据集成平台 ROMA Connect
云解析服务 DNS
专属云
专属计算集群 DCC
IoT物联网
IoT物联网
设备接入 IoTDA
智能边缘平台 IEF
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
国际站常见问题
ICP备案
我的凭证
支持计划
客户运营能力
合作伙伴支持计划
专业服务
区块链
区块链服务 BCS
Web3节点引擎服务 NES
解决方案
SAP
高性能计算 HPC
视频
视频直播 Live
视频点播 VOD
媒体处理 MPC
实时音视频 SparkRTC
数字内容生产线 MetaStudio
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
存储容灾服务 SDRS
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
专属分布式存储服务 DSS
容器
云容器引擎 CCE
容器镜像服务 SWR
应用服务网格 ASM
华为云UCS
云容器实例 CCI
管理与监管
云监控服务 CES
统一身份认证服务 IAM
资源编排服务 RFS
云审计服务 CTS
标签管理服务 TMS
云日志服务 LTS
配置审计 Config
资源访问管理 RAM
消息通知服务 SMN
应用运维管理 AOM
应用性能管理 APM
组织 Organizations
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
应用身份管理服务 OneAccess
数据库
云数据库 RDS
文档数据库服务 DDS
数据管理服务 DAS
数据复制服务 DRS
云数据库 GeminiDB
云数据库 GaussDB
分布式数据库中间件 DDM
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
人脸识别服务 FRS
图引擎服务 GES
图像识别 Image
内容审核 Moderation
文字识别 OCR
AI开发平台ModelArts
图像搜索 ImageSearch
对话机器人服务 CBS
华为HiLens
视频智能分析服务 VIAS
语音交互服务 SIS
应用中间件
分布式缓存服务 DCS
API网关 APIG
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
多活高可用服务 MAS
事件网格 EG
企业协同
华为云会议 Meeting
云通信
消息&短信 MSGSMS
云生态
合作伙伴中心
云商店
开发者工具
SDK开发指南
API签名指南
Terraform
华为云命令行工具服务 KooCLI
其他
产品价格详情
系统权限
管理控制台
客户关联华为云合作伙伴须知
消息中心
公共问题
开发与运维
应用管理与运维平台 ServiceStage
软件开发生产线 CodeArts
需求管理 CodeArts Req
部署 CodeArts Deploy
性能测试 CodeArts PerfTest
编译构建 CodeArts Build
流水线 CodeArts Pipeline
制品仓库 CodeArts Artifact
测试计划 CodeArts TestPlan
代码检查 CodeArts Check
代码托管 CodeArts Repo
云应用引擎 CAE
开天aPaaS
云消息服务 KooMessage
云手机服务 KooPhone
云空间服务 KooDrive
本文导读

限制与兼容性说明

更新时间:2024-08-07 GMT+08:00

在API网关中导入或者导出API时,限制与兼容性如下所示:

限制说明

  • API网关参数限制,如下所示。
    • API网关暂不支持formData和body位置的请求参数定义。
    • API网关暂不支持consumes和produces定义。
    • API网关中,header位置的参数名称,不区分大小写。
  • 后端策略限制,如下所示。
    • 默认后端类型为HTTP,策略后端支持HTTP、HTTP-VPC
    • 默认后端类型为HTTP-VPC,策略后端支持HTTP、HTTP-VPC
    • 默认后端类型为function,策略后端支持function
    • 默认后端类型为mock,策略后端支持mock

兼容性说明

  • 支持OpenAPI规范。

    OpenAPI规范(OAS),是定义一个标准的、与具体编程语言无关的RESTful API的规范。OpenAPI规范的前身是Swagger规范,API网关目前支持两种OpenAPI规范:Swagger 2.0或OpenAPI 3.0。为了方便区分,下文中OAS表示OpenAPI规范(包含Swagger 2.0或OpenAPI 3.0),Swagger表示Swagger 2.0规范,OpenAPI表示OpenAPI 3.0规范。

  • API网关导入或导出的OAS对象,与API网关对象定义的映射关系
  • 请求参数类型与API网关参数类型差异
  • API请求路径模板语法差异
  • 导入API时支持的API网关扩展字段
表1 OAS对象与API网关对象定义的映射关系

Swagger对象

OpenAPI对象

(以3.0.0为例)

API网关对象

导入时行为

导出时行为

info.title

info.title

API分组名称

导入到新的分组:新的分组名称

导入到已有分组:未使用

支持汉字、英文、数字、下划线,且只能以英文或汉字开头,3 ~ 64字符

填充为分组名称

info.description

info.description

API分组描述

导入到新的分组:新的分组描述

导入到已有分组:未使用

填充为分组描述信息

info.version

info.version

版本

未使用

用户指定

未指定则使用当前时间

host

server.url

API分组域名

未使用

优先使用API分组的第一个自定义域名

如果分组未绑定自定义域名则使用分组的独立域名

basePath

-

-

将与每条API的请求路径拼接起来使用

未填充

paths.path

paths.path

API请求路径

与basePath拼接起来作为API请求路径

填充为API请求路径

operation.operationId

operation.operationId

API名称

作为API名称

填充为API名称

operation.description

operation.description

API描述

作为API描述

填充为API描述

operation.parameters

operation.parameters

API前端请求参数

作为API请求参数

填充为API请求参数

operation.schemes

-

API前端请求协议

作为API请求协议

填充为API请求协议

operation.responses

operation.responses

-

未使用

固定填充default响应定义

operation.security

operation.security

API认证方式

API认证方式

结合x-apigateway-auth-type

填充为API认证方式

结合x-apigateway-auth-type

表2 请求参数类型和API网关参数类型差异

OAS类型

API网关类型

支持的参数属性字段

integer

long

float

double

number

maximum

minimum

default

enum

required

description

string

string

maxLength

minLength

default

enum

required

description

其它类型

不支持

不支持

表3 API请求路径模板语法差异

语法

OAS类型

API网关

/users/{userName}

支持

支持

/users/prefix-{userName}

/users/{userName}-suffix

/users/prefix-{userName} -suffix

支持

前端请求定义不支持

后端请求定义支持

/users/{proxy+}

不支持

前端请求定义支持

后端请求定义不支持

我们使用cookie来确保您的高速浏览体验。继续浏览本站,即表示您同意我们使用cookie。 详情

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容