导入API 标准OAS2.0格式与API网关的对应 本章节重点介绍OAS 2.0的格式定义与网关的API定义有对应的映射字段,对于没有对应映射的OAS中的定义,不会影响API的导入。 1. Swagger Object: 1. BasePath:对应分组的BasePath,导入时需要认证; 2. Path Item Object: 1. Path:对应API定义中请求部分的请求path; 2. Method:对应API定义中请求部分的Method,支持GET,POST,PUT,HEAD,DELETE,PATCH,OPTIONS; 3. Operation Object: 1. Summary:对应API定义的描述; 2. OperationId:对应API定义的API名称,如果存在扩展字段“xctyunapigatewayapiname”则使用扩展字段中的内容作为API的名称; 3. Schemes:对应API定义中请求部分支持的协议,优先级高于Swagger Object中的定义; 4. Parameter Object: 1. Name:对应API定义中请求部分的参数名称; 2. In:对应API定义中请求部分的参数位置,支持path,query,head,formdata; 3. Description:对应API定义中请求部分的参数描述; 4. Required:对应API定义中请求部分的参数是否必填; 5. Response Object: 1. HTTP Status Code:对应API定义中定义返回结果中错误码定义中的错误码; 2. Description:对应API定义中定义返回结果中错误码定义中的描述; 3. Schema:对应API定义中定义返回结果中错误码定义中的模型; 6. Definitions Object: 该项定义中的对象,在导入的过程中,API网关会将模型创建在分组下,查看模型定义可以通过分组管理列表下,对应分组的操作栏中的模型管理查看。 标准OAS3.0格式与API网关的对应 本章节重点介绍OAS 3.0的格式定义与API网关的API定义有对应的映射字段,对于没有对应映射的OAS中的定义,不会影响API的导入。 1. Path Item Object 1. Path:对应API定义中请求部分的请求path; 2. Method:对应API定义中请求部分的Method,支持GET,POST,PUT,HEAD,DELETE,PATCH,OPTIONS; 2. Operation Object 1. Summary:对应API定义的描述; 2. OperationId:对应API定义的API名称,如果存在扩展字段“xctyunapigatewayapiname”则使用扩展字段中的内容作为API的名称; 3. Parameter Object 1. Name:对应API定义中请求部分的参数名称; 2. In:对应API定义中请求部分的参数位置,支持path,query,head,formdata; 3. Required:对应API定义中请求部分的参数是否必填; 4. Schema Object: 1. Description:对应API定义中请求部分的参数描述; 2. Type:对应API定义中请求部分的参数类型; 5. Responses Object 1. HTTP Status Code:对应API定义中定义返回结果中错误码定义中的错误码; 2. Description:对应API定义中定义返回结果中错误码定义中的描述; 3. Content:对应API定义中定义返回结果中错误码定义中的模型;