限制与兼容性说明
在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网关扩展字段。
 
| 
        Swagger对象  | 
      
        OpenAPI对象 (以3.0.0为例)  | 
      
        API网关对象  | 
      
        导入时行为  | 
      
        导出时行为  | 
     
|---|---|---|---|---|
| 
        API分组名称  | 
      
        导入到新的分组:新的分组名称 导入到已有分组:未使用 支持汉字、英文、数字、下划线,且只能以英文或汉字开头,3 ~ 64字符  | 
      
        填充为分组名称  | 
     ||
| 
        API分组描述  | 
      
        导入到新的分组:新的分组描述 导入到已有分组:未使用  | 
      
        填充为分组描述信息  | 
     ||
| 
        版本  | 
      
        未使用  | 
      
        用户指定 未指定则使用当前时间  | 
     ||
| 
        API分组域名  | 
      
        未使用  | 
      
        优先使用API分组的第一个自定义域名 如果分组未绑定自定义域名则使用分组的独立域名  | 
     ||
| 
        -  | 
      
        -  | 
      
        将与每条API的请求路径拼接起来使用  | 
      
        未填充  | 
     |
| 
        API请求路径  | 
      
        与basePath拼接起来作为API请求路径  | 
      
        填充为API请求路径  | 
     ||
| 
        API名称  | 
      
        作为API名称  | 
      
        填充为API名称  | 
     ||
| 
        API描述  | 
      
        作为API描述  | 
      
        填充为API描述  | 
     ||
| 
        API前端请求参数  | 
      
        作为API请求参数  | 
      
        填充为API请求参数  | 
     ||
| 
        -  | 
      
        API前端请求协议  | 
      
        作为API请求协议  | 
      
        填充为API请求协议  | 
     |
| 
        -  | 
      
        未使用  | 
      
        固定填充default响应定义  | 
     ||
| 
        API认证方式  | 
      
        API认证方式  | 
      
        填充为API认证方式  |