文档
一个 项目

rewrite

在内部重写请求 URI。

重写会更改请求 URI 的部分或全部内容。请注意,URI 不包括方案或授权(主机和端口),并且客户端通常不会发送片段。因此,此指令主要用于路径查询字符串操作。

rewrite 指令暗示了接受请求的意图,但要进行修改。

它与同一块中的其他 rewrite 指令互斥,因此可以安全地定义否则会级联的重写,因为只会执行第一个匹配的重写。

rewrite 之前匹配请求的 请求匹配器 可能不会在 rewrite 之后匹配相同的请求。如果您希望 rewrite 与其他处理程序共享路由,请使用 routehandle 指令。

语法

rewrite [<matcher>] <to>
  • <to> 是将请求重写到的 URI。只有在重写中指定的 URI(路径或查询字符串)的组件才会被操作。URI 路径是出现在 ? 之前的任何子字符串。如果省略 ?,则整个标记被认为是路径。

类似指令

还有其他执行重写的指令,但它们暗示了不同的意图或在没有完全替换 URI 的情况下执行重写

  • uri 操作 URI(删除前缀、后缀或子字符串替换)。

  • try_files 根据文件是否存在重写请求。

示例

将所有请求重写到 index.html,保持任何查询字符串不变

example.com {
	rewrite * /index.html
}

在所有请求前添加 /api,保留 URI 的其余部分,然后反向代理到应用程序

api.example.com {
	rewrite * /api{uri}
	reverse_proxy localhost:8080
}

将 API 请求上的查询字符串替换为 a=b,保持路径不变

example.com {
	rewrite * ?a=b
}

仅针对 /api/ 的请求,保留现有查询字符串并添加键值对

example.com {
	rewrite /api/* ?{query}&a=b
}

更改路径和查询字符串,保留原始查询字符串,同时将原始路径添加为 p 参数

example.com {
	rewrite * /index.php?{query}&p={path}
}