Skip to content

more than a live-reload server , built for efficient frontend development. base on puer add proxy context

License

Notifications You must be signed in to change notification settings

ufologist/puer-proxy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

86 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

puer-proxy

NPM version changelog license

more than a live-reload server , built for efficient frontend development

puer@1.1.1 的基础上添加了自定义代理上下文的功能, 主要是为了实现#36的需求, 与 puer-mock 配合来使用(必须规范所有的 mock api 都在一个根路径下, 例如 /api/)

添加了如下命令行参数(都是针对代理功能的), 为了不与原来的 puer 冲突, 修改命令为: puer-proxy

  -c,--context <proxyContext>     proxy context
  -r,--rewrite <pathRewrite>      proxy pathRewrite

PS: 只修改了 lib 目录的代码, 没有同步修改 src 目录中的 .coffee 源码...

puer-proxy 增强功能的使用方法

首先当然得安装了, 全局安装还是仅项目安装都可以, 不过一般推荐全局安装了

npm install puer-proxy -g

假设你要代理的后端接口在 http://localhost:8080, 一般的使用方法为同时指定代理的上下文并使用路径重写功能

puer-proxy -c /api/ -r -t http://localhost:8080

这样达到的效果是: 当请求 http://localhost:8000/api/path/to/something 时将请求代理给 http://localhost:8080/path/to/something 来处理, 默认的 -r 参数会将上下文路径(即这里的 /api/)重写为空字符串再提交给代理的服务器

如果你习惯将所有的 mock api 都定义在 /api/ 路径下, 那么可以更简单的运行下面的命令

puer-proxy -r -t http://localhost:8080

下面详情解释每个参数的含义

  • 自定义代理的上下文(-c,--context), 默认为 /api/

    puer-proxy -c /api/ -t http://localhost:8080

    即当请求 http://localhost:8000/api/path/to/something 时将请求代理给 http://localhost:8080/api/path/to/something 来处理

    注意: 以斜杠结尾, 否则会匹配到 /apipath/to/something 这样的路径

  • 关闭路径重写功能

    不在命令行传入 -r 参数, 则请求的路径给代理时不会被重写

  • 自定义路径重写功能(-r,--rewrite)

    puer-proxy -c /api/ -r /abc/ -t http://localhost:8080

    即当请求 http://localhost:8000/api/path/to/something 时将请求代理给 http://localhost:8080/abc/path/to/something 来处理

  • puer-mock 搭配使用的例子

    需要先安装好 puer-mock, 具体使用场景

    puer-proxy -a _mockserver.js -c /api/ -r -t http://localhost:8080

puer 原本功能的使用方法

其他使用说明请参考官网文档 leeluolee/puer, 非常感谢 leeluolee/puer 给我们带来了很多效率的提升.

原来的实现方式

About

more than a live-reload server , built for efficient frontend development. base on puer add proxy context

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 90.4%
  • JavaScript 9.6%