rewrite 参考了Nginx配置语法,通过简单的配置,就可以帮助前端开发在本地调试的基础上,方便的利用其他环境或者线上的API接口进行测试。
当服务启动后,将自动扫描并监听各项目根目录下的文件,生成及实时更新转发规则,无需重启服务。
注:hiproxy同时支持项目rewrite
及文件。如果仅需要简单的转发,请参考hosts。
语法
例子
- # 定义变量
set $var_name value
# 使用变量
$var_name
domain
语法
- [域名|变量] => {
# ...
}
例子
- set $domain some.example.com
# 直接使用域名
some.example.com => {
# ...
}
# 或者使用变量
$domain => {
# ...
}
或者
- set $domain some.example.com
# 直接使用域名
domain some.example.com {
# ...
}
# 或者使用变量
domain $domain {
# ...
}
location 用来指定域名中的一个具体的路径,这个路径的所有配置都在 location 块中。
注意:location必须位于domain块中。
语法
- # 目录
location /some/path/ {
# ...
}
# 具体文件
location /some/file.htm {
# ...
}
# 正则表达式
location ~ ^/some/(path|path1)/.* {
# ...
}
# 变量
location $some/$path {
# ...
}
命令
命令用于设置一些变量,或者对request
\/做一些操作。
语法
例子
- # 设置代理时的头部
proxy_set_header Host some.example.com;
# 设置response的cookie
set_cookie UserID some_user_id;
用来注释某些不需要的内容,只支持单行注释。
语法
- # 注释内容
简写语法
简写语法,可以用来定义一些基本的规则,不需要写location
和其他的命令。
例子
- json.example.com => 127.0.0.1:8800;
- set $local 127.0.0.1:8800
# simple rewrite rule
api.hiproxy.org => local.hiproxy.org;
api.hiproxy.org => 127.0.0.1:8800;
api.hiproxy.org/mock => $local/mock;
- # rewrite folder
api.hiproxy.org/user/ => {
proxy_pass local.hiproxy.org/user/;
# proxy request config
proxy_set_header Host api.hiproxy.org;
proxy_set_header other value;
proxy_hide_header other;
proxy_set_cookie userid 20150910121359;
proxy_hide_cookie sessionid;
# response config
set_cookie sessionID E3BF86A90ACDD6C5FF49ACB09;
set_header proxy hiproxy;
# allow CORS
set_header Access-Control-Allow-Origin *;
hide_header proxy;
hide_cookie sessionID;
}
- # regexp support
~ /(demo|example)/([^\/]*\.(html|htm))$ => {
proxy_pass http://127.0.0.1:9999/$1/src/$2;
}