Linux怎么配置Nginx返回JSON格式 Nginx自定义响应内容详解

Linux怎么配置Nginx返回JSON格式 Nginx自定义响应内容详解

想让Nginx直接返回JSON数据？用return指令配合default_type application/json确实是最直接的路径。但实际操作中，漏掉任何一个关键配置项，都可能导致浏览器直接下载文件、中文显示为乱码，或者状态码不符合预期。这些问题通常不是Nginx的功能缺陷，而是响应头和语法细节没有完全对齐导致的。

location 中用 return 返回 JSON 的基本写法

想让return指令顺利吐出JSON，必须同时满足三个条件：状态码要显式指定、default_type要设置正确、JSON字符串本身要用单引号包裹且不能有换行。

• 状态码不能省：比如必须写成return 200，只写一个孤零零的return是不行的。
• Content-Type必须声明：default_type application/json这一行至关重要。少了它，浏览器就收不到正确的Content-Type头，很可能会把响应当成二进制文件来处理，触发下载。
• 字符串用单引号：JSON字符串必须用单引号（'{}'）包裹。因为在Nginx配置语境下，双引号容易被shell或配置解析器提前截断，引发语法错误。
• 保持字符串在一行：字符串内部不能有未转义的换行符，否则运行nginx -t检查配置时会报invalid number of arguments错误。

来看一个标准的示例：

location ~ ^/api/status$ {
    default_type application/json;
    return 200 '{"status":"ok","uptime":12345}';
}

中文 JSON 返回乱码的根源和修复

Nginx默认不会在响应头里声明字符集。虽然Linux系统普遍使用UTF-8编码，但一些浏览器（特别是旧版本的Chrome或IE）在没收到charset信息时，可能会“自作主张”地回退到GBK等编码，导致中文变成一堆方块或问号。

• 别只依赖default_type：default_type application/json只设置了MIME类型，并不包含编码信息。
• 必须显式声明UTF-8：最可靠的方法是使用add_header Content-Type 'application/json; charset=utf-8'。也可以使用更简洁的charset utf-8指令。
• 注意指令的适用范围：需要留意的是，charset指令通常只对text/*类型的响应生效，对application/json可能无效。因此，优先推荐使用add_header来确保万无一失。

正确的配置应该像这样：

location ~ ^/api/hello$ {
    default_type application/json;
    add_header Content-Type 'application/json; charset=utf-8';
    return 200 '{"msg":"你好，世界"}';
}

给限流/错误场景返回自定义 JSON（如 429）

当使用limit_req进行限流时，Nginx默认返回的是503状态码。然而，429（Too Many Requests）才是更语义化、更符合RESTful规范的选择。Nginx本身不会自动为这个状态码映射自定义响应体，这就需要我们手动搭建一个“桥梁”。

• 第一步：定义限流区：在http块中配置限流规则，例如limit_req_zone $binary_remote_addr zone=api:10m rate=5r/s。
• 第二步：应用限流：在目标server或location中启用限流，如limit_req zone=api burst=10 nodelay。
• 第三步：错误页面重定向：使用error_page 429 = @rate_limited指令，将429错误定向到一个命名的location（named location）进行处理。
• 第四步：构造JSON响应：在命名的location中，必须同时使用return 429和add_header Content-Type来返回JSON。如果少了add_header

server {
    error_page 429 = @rate_limited;

    location @rate_limited {
        add_header Content-Type 'application/json; charset=utf-8';
        return 429 '{"code":429,"message":"请求过于频繁，请稍后再试"}';
    }

    location /api/ {
        limit_req zone=api burst=10 nodelay;
        # ... 其他配置
    }
}

location ~ ^/user/(\d+)$ {
    default_type application/json;
    add_header Content-Type 'application/json; charset=utf-8';
    return 200 '{"id":$1,"type":"user"}';
}