导入API 扩展字段 OAS中位置 含义 类型 示例 说明 xctyunapigatewayapiname Operation API名称 String “apinametest” 优先于operationId的值作为api名称 xctyunapigatewayisantireplay Operation 是否设置防重放攻击 Boolean true 只支持true和false, 默认false xctyunapigatewaybackend Operation 后端服务定义 Object { "gwServiceCode" :"ea180dd257714a56af39d3408fdf072b","postPath" : "/", "postMethod" : "GET","timeout" : 10000.0} ·gwServiceCode为已创建的API服务Code,必填; ·postPath为后端请求path,不填写则默认与api中的path一致; ·postMethod为后端转发method,不填写则与api中的method一致; ·timeout为后端服务超时时间,单位是ms,不填写默认为10000. xctyunapigatewaycommonparameters Operation 常量参数定义 Object [{"paramName" : "spuinstId","paramValue" : "swdeefd","paramLocation" : "query","description" : ""},{"paramName" : "version","paramValue" : "v1","paramLocation" : "header","description" : ""}] 该字段的值是一个对象列表,可填写多个常量参数。 ·paramName为常量参数名称 ·paramValue为常量参数值 ·paramLocation为常量参数位置,只支持query和header两种,不填写则默认query·description为描述信息 xctyunapigatewaysystemparameters Operation 系统参数定义 Object [ {"systemParamName" : "routeName","paramName" : "aaa","paramLocation" : "query","description" : ""},{"systemParamName" : "upstreamPort","paramName" : "port","paramLocation" : "header","description" : ""}] 该字段的值是一个对象列表,可填写多个系统参数。 ·systemParamName为系统参数名称,目前支持的有upstreamId, upstreamPort, routeId, routeName, serviceId, serviceName·paramName为对应的赋值参数名称 ·paramLocation为系统参数位置,只支持query和header两种,不填写则默认query·description为描述信息 xctyunapigatewayrequestargumentmode Operation 入参请求模式 String “MAPPINGFILTER” 支持三种入参请求模式: ·MAPPINGFILTER:入参映射(支持过滤参数) ·MAPPINGPASS:入参映射(透传未知参数) ·PASS:入参透传不填写默认为PASS xctyunapigatewayresponsemessages Responses 错误码错误信息 String “This is errorCodemessage” xctyunapigatewayparameterdemo Parameter 参数定义示例值 String xctyunapigatewaybackendlocation Parameter 后端服务参数映射位置 String “path” 只支持path,query和header,不填写时默认与api入参定义参数位置一致 xctyunapigatewaybackendname Parameter 后端服务参数映射名称 String “abc” 不填写时默认与api入参定义参数名称一致 xctyunapigatewaysuccessdemo Operation 返回结果示例 String “This is a success demo” xctyunapigatewayfaileddemo Operation 失败结果示例 String “This is a failed demo” xctyunapigatewayrequestbodyschema Operation 请求body引用模型名称 String “people” 只有当请求方法为post, patch, put, delete,且body数据类型为Json时,该字段才生效,引用的模型名称应存在模型定义中 xctyunapigatewayrequestbodydescription Operation 请求body内容描述 String 生效条件同上