API网关 APIG-开启跨域访问:非简单请求

时间:2024-04-09 20:49:19

非简单请求

对于非简单请求,您需要开启跨域访问,并且创建一个“Method”为“OPTIONS”的API。

跨域共享资源插件不需要创建一个“Method”为“OPTIONS”的API。

“Method”为“OPTIONS”的API和普通API的区别如下:

  • 所属分组:选择已开启CORS的API所在的分组。
  • 安全认证:可选择“无认证”。无论选择哪种认证方式,API网关都按照无认证处理。
  • 请求协议:选择与已开启CORS的API相同的请求协议。
  • 请求Path:填斜杠/即可,也可选择与已开启CORS的API相同或者匹配的请求Path。
  • Method:选择“OPTIONS”。
  • 支持CORS:选择开启CORS。

假设后端服务类型为Mock,示例如下:

浏览器发送“Method”为“OPTIONS”的API请求:

OPTIONS /HTTP/1.1
User-Agent: curl/7.29.0
Host: localhost
Accept: */*
Origin: http://www.cors.com
Access-Control-Request-Method: PUT 
Access-Control-Request-Headers: X-Sdk-Date
  • Origin:此字段必选,表示请求消息所属源。
  • Access-Control-Request-Method:此字段必选,表示请求会使用哪些HTTP请求方法。
  • Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。

后端服务返回消息:

API网关返回消息:

HTTP/1.1 200 OK
Date: Tue, 15 Jan 2019 02:38:48 GMT
Content-Type: application/json
Content-Length: 1036
Server: api-gateway
X-Request-Id: c9b8926888c356d6a9581c5c10bb4d11
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: X-Stage,X-Sdk-Date,X-Sdk-Nonce,X-Proxy-Signed-Headers,X-Sdk-Content-Sha256,X-Forwarded-For,Authorization,Content-Type,Accept,Accept-Ranges,Cache-Control,Range
Access-Control-Expose-Headers: X-Request-Id,X-Apig-Latency,X-Apig-Upstream-Latency,X-Apig-RateLimit-Api,X-Apig-RateLimit-User,X-Apig-RateLimit-App,X-Apig-RateLimit-Ip,X-Apig-RateLimit-Api-Allenv
Access-Control-Allow-Methods: GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH
Access-Control-Max-Age: 172800
  • Access-Control-Allow-Origin:此字段必选,“*”表示API网关接受任意域的请求。
  • Access-Control-Allow-Headers:当请求消息中包含此字段时,此字段必选。表示允许跨域的所有请求头信息字段。
  • Access-Control-Expose-Headers:表示跨域访问允许查看的返回头信息字段。
  • Access-Control-Allow-Methods:此字段必选,表示API网关支持的所有HTTP请求方法。
  • Access-Control-Max-Age:此字段可选,表示本次预检的有效期,单位:秒。在有效期内,无需再次发出预检请求。

浏览器发送一个带Origin字段的请求头:

PUT /simple HTTP/1.1
Host: www.test.com
Origin: http://www.cors.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Accept: application/json
Date: Tue, 15 Jan 2019 01:25:52 GMT

后端服务返回消息:

HTTP/1.1 200 OK
Date: Tue, 15 Jan 2019 01:25:52 GMT
Content-Type: application/json
Content-Length: 16
Server: api-gateway

{"status":"200"}

API网关返回消息:

HTTP/1.1 200 OK
Date: Tue, 15 Jan 2019 01:25:52 GMT
Content-Type: application/json
Content-Length: 16
Server: api-gateway
X-Request-Id: 454d689fa69847610b3ca486458fb08b
Access-Control-Allow-Origin: *

{"status":"200"}

support.huaweicloud.com/usermanual-apig/apig-ug-180621094.html