跨域访问 API

erda.yml 配置

您可以通过 erda.yml 配置跨域访问限制,具体请参见 使用 erda.yml 管理配置

  1. policies:
  2. cors:
  3. # 必填字段,当为 any 时,允许 origin 是任何域名进行跨域访问
  4. allow_origins: any
  5. # 非必填,默认是 any,允许 http method 是任何类型
  6. allow_methods: any
  7. # 非必填,默认是 any,允许 http header 是任何字段
  8. allow_headers: any
  9. # 非必填,默认是 true,允许 cookie 字段跨域传输
  10. allow_credentials: true
  11. # 非必填,默认是 86400,跨域预检请求一次成功后的有效时间
  12. max_age: 86400

流量入口 API 策略设置

您也可以通过流量入口下的 API 策略进行配置。

具体操作路径如下:

  • 全局策略:进入 微服务治理平台 > 项目列表 > 选择项目 > API 网关 > 流量入口管理,选择对应的流量入口,点击 详情 > 全局策略 > 业务策略 > 跨域访问
  • 具体 API 策略:进入 微服务治理平台 > 项目列表 > 选择项目 > API 网关 > 流量入口管理,选择对应的流量入口,点击 详情 后选择对应的 API,点击 策略 > 业务策略 > 跨域访问

::: tip 提示

如果您已通过 erda.yml 完成了配置,前者将覆盖此处配置。

:::

示例一

若需求为:

  • 允许所有外部站点调用任意 HTTP 方法。
  • 开放的 API 无需携带 Cookie 即可访问,禁止来自外部站点的 Cookie 透传以保障安全。

则配置示意如下:

跨域访问 API - 图1

若使用 erda.yml 配置,则配置信息如下:

  1. policies:
  2. cors:
  3. allow_origins: any
  4. allow_methods: any
  5. allow_headers: any
  6. allow_credentials: false

示例二

若需求为仅允许域名符合 *.example.com 的站点访问,可调用任意方法,可携带 Cookie,则需先关闭跨域访问策略,再通过 自定义 nginx 配置 实现。

  1. 关闭跨域访问策略。

    跨域访问 API - 图2

  2. 开启 nginx 自定义配置.

    跨域访问 API - 图3

  3. nginx 配置示意如下:

    1. set $methodandorigin $request_method$http_origin;
    2. if ($http_origin ~* 'https?://.*\.example\.com$') {
    3. more_set_headers 'Access-Control-Allow-Origin: $http_origin';
    4. more_set_headers 'Access-Control-Allow-Methods: GET, PUT, POST, DELETE, PATCH, OPTIONS';
    5. more_set_headers 'Access-Control-Allow-Credentials: true';
    6. }
    7. if ($methodandorigin ~* '^OPTIONS-https?://.*\.example\.com$') {
    8. more_set_headers 'Access-Control-Allow-Origin: $http_origin';
    9. more_set_headers 'Access-Control-Allow-Methods: GET, PUT, POST, DELETE, PATCH, OPTIONS';
    10. more_set_headers 'Access-Control-Allow-Headers: $http_access_control_request_headers';
    11. more_set_headers 'Access-Control-Allow-Credentials: true';
    12. more_set_headers 'Access-Control-Max-Age: 86400';
    13. more_set_headers 'Content-Type: text/plain charset=UTF-8';
    14. more_set_headers 'Content-Length: 0';
    15. return 200;
    16. }