Apigee 飞行前选项请求

Question

我创建 API 代理并选中“为您的 API 启用直接浏览器访问 - 允许通过 CORS 来自浏览器的直接请求”复选框。但我的 OPTIONS 请求仍然失败：

{
    "fault": {
        "faultstring": "Received 405 Response without Allow Header",
        "detail": {
            "errorcode": "protocol.http.Response405WithoutAllowHeader"
        }
    }
}

根据我对 CORS Pre-Flight Options 请求的理解，客户端首先将 OPTIONS 请求发送到服务器，作为“安全”CORS 的保障。此请求应返回一个响应，其中包含可用的请求类型列表。

我的问题： 如何使 Apigee 正确响应 OPTIONS 请求并且 不将 OPTIONS 请求传递到代理后面的 API？。如果有帮助，我可以让 AngularJS JavaScript 应用尝试与我的 Apigee 端点进行通信。

JavaScript 错误：

选项 http://api.example.com 请求的资源上不存在“Access-Control-Allow-Origin”标头。因此，不允许访问来源“http://client.example.com”。

XMLHttpRequest 无法加载 http://api.example.com。请求的资源上不存在“Access-Control-Allow-Origin”标头。因此，不允许访问来源“http://client.example.com”。

默认“添加 CORS”xml

<AssignMessage async="false" continueOnError="false" enabled="true" name="Add-CORS">
    <DisplayName>Add CORS</DisplayName>
    <FaultRules/>
    <Properties/>
    <Add>
        <Headers>
            <Header name="Access-Control-Allow-Origin">*</Header>
            <Header name="Access-Control-Allow-Headers">origin, x-requested-with, accept</Header>
            <Header name="Access-Control-Max-Age">3628800</Header>
            <Header name="Access-Control-Allow-Methods">GET, PUT, POST, DELETE</Header>
        </Headers>
    </Add>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="response"/>
</AssignMessage>

默认代理端点 xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
    <Description/>
    <Flows/>
    <PreFlow name="PreFlow">
        <Request/>
        <Response/>
    </PreFlow>
    <HTTPProxyConnection>
        <BasePath>/v1/cnc</BasePath>
        <VirtualHost>default</VirtualHost>
        <VirtualHost>secure</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
    </RouteRule>
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
</ProxyEndpoint>

默认目标端点 xml

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<TargetEndpoint name="default">
    <Description/>
    <Flows/>
    <PreFlow name="PreFlow">
        <Request/>
        <Response>
            <Step>
                <Name>Add-CORS</Name>
            </Step>
        </Response>
    </PreFlow>
    <HTTPTargetConnection>
        <URL>http://api.example.com/v1/assets.json</URL>
    </HTTPTargetConnection>
    <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
</TargetEndpoint>

Answer 1

由于您不希望 OPTIONS 请求传递到后端 API，因此需要做两件事：

1. 指向空目标的 RouteRule，具有 OPTIONS 请求的条件。请注意，没有指定 TargetEndpoint。

   <RouteRule name="NoRoute">
       <Condition>request.verb == "OPTIONS"</Condition>
   </RouteRule>
   

2. ProxyEndpoint 中用于处理 CORS 响应的自定义流程。 由于新 RouteRule 将消息发送到空目标（将请求回显给客户端），因此该消息不会路由到当前定义 CORS 策略的“默认”TargetEndpoint。

您的 ProxyEndpoint 的更新版本如下所示：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ProxyEndpoint name="default">
    <Description/>
    <Flows>
        <Flow name="OptionsPreFlight">
            <Request/>
            <Response>
                <Step>
                    <Name>Add-CORS</Name>
                </Step>
            </Response>
        <Condition>request.verb == "OPTIONS"</Condition> 
        </Flow>
    </Flows>
    <PreFlow name="PreFlow">
        <Request/>
        <Response/>
    </PreFlow>
    <HTTPProxyConnection>
        <BasePath>/v1/cnc</BasePath>
        <VirtualHost>default</VirtualHost>
        <VirtualHost>secure</VirtualHost>
    </HTTPProxyConnection>
    <RouteRule name="NoRoute">
        <Condition>request.verb == "OPTIONS"</Condition>
    </RouteRule>
    <RouteRule name="default">
        <TargetEndpoint>default</TargetEndpoint>
   </RouteRule>
   <PostFlow name="PostFlow">
        <Request/>
        <Response/>
    </PostFlow>
</ProxyEndpoint>

注意：RouteRules 按照 ProxyEnpoint 配置中指定的顺序进行评估。 最后应该始终有默认（无条件）路线。 否则，如果位于顶部，它将始终匹配并且从不评估其他路线的可能性。

Answer 2

我做了上面答案中提到的同样的事情，但仍然遇到同样的问题。然后经过一些研究，问题就解决了。

问题在于 cors 标头响应在请求期间未作为标头传递。要解决这个问题，您可以在代理端点预流中添加 cors 值：

<PreFlow name="PreFlow">
    <Request/>
    <Response>
        <Step>
            <Name>Add-CORS</Name>
        </Step>
    </Response>
</PreFlow>