https://github.com/saqqdy/egg-http-proxy-plus
基于最新的http-proxy-middleware开发的更加智能的的egg代理中间件，解决了代理文件上传接口的问题
https://github.com/saqqdy/egg-http-proxy-plus
egg egg-plugin egg-proxy file-upload http-proxy proxy proxy-plus rawbody rawdata
Last synced: 10 months ago
JSON representation
基于最新的http-proxy-middleware开发的更加智能的的egg代理中间件，解决了代理文件上传接口的问题
- Host: GitHub
- URL: https://github.com/saqqdy/egg-http-proxy-plus
- Owner: saqqdy
- License: mit
- Created: 2020-11-30T04:40:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-19T05:23:27.000Z (almost 3 years ago)
- Last Synced: 2024-10-31T17:14:03.202Z (over 1 year ago)
- Topics: egg, egg-plugin, egg-proxy, file-upload, http-proxy, proxy, proxy-plus, rawbody, rawdata
- Language: JavaScript
- Homepage:
- Size: 438 KB
- Stars: 15
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# egg-http-proxy-plus
支持转发文件上传接口，支持自定义匹配方法，ctx 透传
[![NPM version][npm-image]][npm-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![Test coverage][codecov-image]][codecov-url]
[![npm download][download-image]][download-url]
[![License][license-image]][license-url]
[![Sonar][sonar-image]][sonar-url]
Configure proxy middleware for egg. Use [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware).
## Install
```bash
# use npm
$ npm i egg-http-proxy-plus --save
# use yarn
$ yarn add egg-http-proxy-plus
```
## Usage
```js
// {app_root}/config/plugin.js
exports.httpProxyPlus = {
enable: true,
package: 'egg-http-proxy-plus'
}
```
## Configuration
### Proxy `/api` requests to `http://www.example.org`
```js
// {app_root}/config/config.default.js
exports.httpProxyPlus = {
'/api': 'http://www.example.org'
}
// or
exports.httpProxyPlus = [
{
origin: '/api',
options: 'http://www.example.org'
}
]
```
#### A request to `/api/users` will now proxy the request to `http://www.example.org/api/users`
If you don't want `/api` to be passed along, we need to rewrite the path:
```js
// {app_root}/config/config.default.js
exports.httpProxyPlus = {
'/api': {
target: 'http://www.example.org',
pathRewrite: { '^/api': '' }
}
}
// or
exports.httpProxyPlus = [
{
origin: '/api',
options: {
target: 'http://www.example.org',
pathRewrite: { '^/api': '' }
// ...
}
}
]
```
#### custom matching
For full control you can provide a custom function to determine which requests should be proxied or not.
```js
// {app_root}/config/config.default.js
exports.httpProxyPlus = [
{
origin(pathname, req) {
return pathname.match('^/api') && req.method === 'GET'
},
options: {}
}
]
```
#### http-proxy events
Pay attention to the fourth parameter, the plug-in transparently transmits the ctx context
```js
// {app_root}/config/config.default.js
exports.httpProxyPlus = {
'/api': {
target: 'http://www.example.org',
onProxyReq(proxyReq, req, res, ctx) {
if (req.method.toLowerCase() === 'post') {
const token = ctx.cookies.get('access_token')
token && proxyReq.setHeader('authorization', token)
}
}
}
}
```
For more advanced usages, checkout [http-proxy-middleware](https://github.com/chimurai/http-proxy-middleware#options) options documentation.
## Questions & Suggestions
Please open an issue [here](https://github.com/saqqdy/egg-http-proxy-plus/issues).
## License
[MIT](LICENSE)
[npm-image]: https://img.shields.io/npm/v/egg-http-proxy-plus.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-http-proxy-plus
[codacy-image]: https://app.codacy.com/project/badge/Grade/f70d4880e4ad4f40aa970eb9ee9d0696
[codacy-url]: https://www.codacy.com/gh/saqqdy/egg-http-proxy-plus/dashboard?utm_source=github.com&utm_medium=referral&utm_content=saqqdy/egg-http-proxy-plus&utm_campaign=Badge_Grade
[codecov-image]: https://img.shields.io/codecov/c/github/saqqdy/egg-http-proxy-plus.svg?style=flat-square
[codecov-url]: https://codecov.io/github/saqqdy/egg-http-proxy-plus?branch=master
[download-image]: https://img.shields.io/npm/dm/egg-http-proxy-plus.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-http-proxy-plus
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE
[sonar-image]: https://sonarcloud.io/api/project_badges/quality_gate?project=saqqdy_egg-http-proxy-plus
[sonar-url]: https://sonarcloud.io/dashboard?id=saqqdy_egg-http-proxy-plus