location /api/ { proxy_pass http://api_server; }有什么作用？

在Nginx中配置 location /api/ { proxy_pass http://api_server; } 时，Nginx会将所有以 /api/ 开头的请求路径转发到后端服务 http://api_server，但路径替换规则 取决于 proxy_pass 的写法。以下是详细解释和示例：

---

1. 配置效果分析

情况1：proxy_pass 以 / 结尾（推荐写法）

nginx
location /api/ {
    proxy_pass http://api_server/;  # 注意末尾的 `/`
}

• 规则 ：Nginx 会移除 匹配的 /api/ 前缀，再将剩余路径拼接到 proxy_pass 的地址后。

• 示例：

  • 客户端请求：http://nginx-server/api/users?id=123
  • 转发到后端：http://api_server/users?id=123

情况2：proxy_pass 不以 / 结尾

nginx
location /api/ {
    proxy_pass http://api_server;  # 无末尾 `/`
}

• 规则 ：Nginx 会保留 /api/ 前缀，直接拼接到 proxy_pass 的地址后。

• 示例：

  • 客户端请求：http://nginx-server/api/users?id=123
  • 转发到后端：http://api_server/api/users?id=123

---

2. 完整请求转发示例

假设以下配置：

nginx
server {
    listen 80;
    server_name nginx-server.com;
 
    location /api/ {
        proxy_pass http://api_server:8080/;  # 末尾有 `/`
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

步骤1：客户端发起请求

• 浏览器访问：
  http://nginx-server.com/api/users/123?name=foo

步骤2：Nginx 处理路径

1. 匹配 location /api/，移除 /api/ 前缀，剩余路径为 users/123?name=foo。
2. 拼接到 proxy_pass 的地址后，得到完整后端地址：
   http://api_server:8080/users/123?name=foo

步骤3：转发到后端服务

• Nginx 向 http://api_server:8080/users/123?name=foo 发起请求。
• 后端服务（如Spring Boot、Express等）收到请求并处理。

步骤4：后端响应返回客户端

• 后端返回的数据通过 Nginx 原样透传给浏览器。

---

3. 关键注意事项

(1) 路径拼接规则

• 带斜杠 / ：proxy_pass http://api_server/;
/api/test → /test
• 不带斜杠 ：proxy_pass http://api_server;
/api/test → /api/test

(2) 查询参数（?key=value）

• 查询参数（如 ?id=123）会自动保留，无需额外配置。

(3) 请求头传递

• 必须通过 proxy_set_header 传递关键头信息，否则后端可能无法获取客户端真实IP或原始域名：

  nginx
  proxy_set_header Host $host;
  proxy_set_header X-Real-IP $remote_addr;
  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

(4) 后端服务上下文路径

• 如果后端服务本身有上下文路径（如 http://api_server:8080/service/），需在 proxy_pass 中明确：

  nginx
  location /api/ {
      proxy_pass http://api_server:8080/service/;  # 拼接后为 /service/users
  }

---

4. 调试技巧

• 查看实际转发地址 ：

  在 Nginx 配置中添加日志，记录转发前的 $request_uri 和转发后的 $proxy_host$uri：

  nginx
  log_format proxy_log '[$time_local] "$request" -> "$proxy_host$uri"';
  access_log /var/log/nginx/proxy.log proxy_log;

• 测试工具 ：

  使用 curl 模拟请求，观察后端日志：

  bash
  curl -v "http://nginx-server.com/api/users?id=123"

---

5. 常见问题

问题1：后端收到404

• 原因 ：proxy_pass 路径拼接错误，导致后端找不到接口。
• 解决 ：检查 location 和 proxy_pass 的斜杠规则，或通过后端日志确认实际请求路径。

问题2：重定向循环

• 原因 ：后端返回的 Location 头（如302重定向）可能包含后端内部路径，需通过 proxy_redirect 修正：

  nginx
  proxy_redirect http://api_server:8080/ /api/;

---

总结

• 推荐写法 ：proxy_pass http://api_server/;（带斜杠），避免路径重复。
• 核心流程 ：Nginx 根据 location 匹配路径 → 移除或保留前缀 → 拼接 proxy_pass 地址 → 转发请求。
• 验证方法 ：通过日志和 curl 逐步测试路径转换逻辑。