GCP API Gateway忽略URL尾斜杠调用GAE上Django接口报错如何解决

问题根因 #

1. 重定向循环：API Gateway默认路径转发规则下，访问网关/hello路径时，会直接将不带尾斜杠的路径转发给GAE。Django默认开启APPEND_SLASH配置，收到无尾斜杠的路径请求时会自动返回301重定向到带尾斜杠的/hello/路径，重定向响应返回给客户端后，域名会被替换为网关域名，而网关未配置/hello/路径的匹配规则，触发循环跳转。
2. 配置APPEND_SLASH=False后出现404：OpenAPI配置中x-google-backend默认使用APPEND_PATH_TO_ADDRESS路径翻译规则，会将请求路径直接拼接到后端地址根域名后，忽略你在address字段中填写的路径后缀，最终转发到GAE的路径仍然是不带尾斜杠的/hello，和关闭自动补全斜杠后的Django路由不匹配。

之前对接Flask接口无异常是因为Flask默认对路径尾斜杠的匹配规则更宽松，/hello和/hello/会命中同一个路由，不会触发重定向或404。

解决方案 #

方案1：修改路径翻译规则（无需调整Django配置） #

在x-google-backend配置中新增path_translation: CONSTANT_ADDRESS参数，该配置会让网关直接将请求转发到address字段填写的完整地址，不会修改路径后缀，配置示例：

paths:
  /hello:
    get:
      summary: Just a simple get function
      operationId: hello
      x-google-backend:
        address: https://myfakeapp.uk.a.appspot.com/hello/
        path_translation: CONSTANT_ADDRESS # 新增这一行
      responses:
        '200':
          description: A successful response
          schema:
            type: string

该方案适合单接口或者路径映射规则不统一的场景，不需要修改Django原有配置。

方案2：统一前后端路径规则（适合多接口批量配置） #

如果有大量接口需要对接，推荐统一路径规则适配默认转发逻辑：

• 将x-google-backend的address字段仅填写GAE根域名，不要带接口路径
• 保持DjangoAPPEND_SLASH配置不变，网关OpenAPI的路径配置和Django路由规则完全对齐：
  • 如果Django路由带尾斜杠，网关同时配置/hello和/hello/两个路径，或者开启路径匹配的尾斜杠兼容
  • 如果关闭了APPEND_SLASH，Django路由不带尾斜杠，网关也配置为/hello路径即可

配置示例：

x-google-backend:
  address: https://myfakeapp.uk.a.appspot.com # 仅保留根域名
# paths配置和Django路由完全对齐
paths:
  /hello:
    get:
      xxx
  /hello/:
    get:
      xxx

注意事项 #

• 调整完OpenAPI配置后需要重新发布网关配置才会生效
• 不要同时修改APPEND_SLASH配置和后端路径映射规则，避免出现路径匹配混乱

内容的提问来源于stack exchange，提问作者dy1