APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放CCE工作负载 云容器引擎（Cloud

查看更多 →

x-apigateway-pass-through 含义：API的请求参数是否透传。always为是，never为否。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： paths: /: get: parameters:

查看更多 →

x-apigateway-ratelimits 含义：流控策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-ratelimits: customRatelimitName: api-limit: 200 app-limit:

查看更多 →

x-apigateway-sample 含义： API的请求参数示例值。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： paths: /: get: parameters: - maximum:

查看更多 →

x-apigateway-orchestrations 含义： API请求参数的编排规则列表。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： paths: /: get: parameters:

查看更多 →

x-apigateway-ratelimit 含义：引用流控策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-ratelimit:

查看更多 →

x-apigateway-plugins 含义：API网关定义的API插件服务。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-plugins:

查看更多 →

x-apigateway-access-control 含义：引用访问控制策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-access-control:

查看更多 →

x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:

查看更多 →

x-apigateway-response 含义：API的网关响应名称。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： paths: /: get: x-apigateway-response: test

查看更多 →

x-apigateway-result-normal-sample 含义：成功响应示例。 作用域： Operation Responses 示例： paths: /: get: responses: default: x

查看更多 →

x-apigateway-content-type 含义： API的请求内容类型。 作用域： Operation Object(2.0) 示例： paths: /: get: x-apigateway-content-type: application/json

查看更多 →

x-apigateway-backend 含义：API网关定义的API后端服务定义。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get: produces:

查看更多 →

x-apigateway-responses 含义：自定义网关响应类型。 作用域： Operation Object(2.0)/Operation Object(3.0) 示例： x-apigateway-responses: default: ACCESS_DENIED:

查看更多 →

x-apigateway-match-mode 含义：API网关定义的API请求URL的匹配模式，支持NORMAL和SWA。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:

查看更多 →

x-apigateway-auth-opt 含义：APP简易认证方式参数。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger示例： securityDefinitions: apig-auth-app:

查看更多 →

x-apigateway-any-method 含义：API网关定义的API请求方法，用以匹配未指定定义的HTTP方法。 作用域：Path Item Object(2.0)/Path Item Object(3.0) 示例： paths: '/path': get:

查看更多 →

x-apigateway-access-controls 含义：访问控制策略名称与关联策略映射。 作用域：Swagger Object 示例： x-apigateway-access-controls: customAccessControlName: acl-type:

查看更多 →

x-apigateway-request-type 含义：API网关定义的API请求类型，支持public和private。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get:

查看更多 →

x-apigateway-ratelimits.policy.special 含义：特殊流控策略定义。 作用域：x-apigateway-ratelimits.policy 示例： x-apigateway-ratelimits: customRatelimitName:

查看更多 →

\"}" } app_auth_header 请求头中的APP认证的签名信息的头域可以由此处的配置项承载。 - 支持英文、数字、中划线、下划线，以英文开头，3-64个字符，可以为空，不能以x-apig、x-sdk开头，不区分大小写，不能是x-stage、authorization，不区分大小写

查看更多 →