Package Exports

http-proxy-config

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (http-proxy-config) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

http-proxy-config

Easy to set proxy options for http-proxy-middleware.

Install

npm install -D http-proxy-config

Usage

Proxy support format: String, Array or Object.

package.json

"dependencies": {
...
},
"devDependencies": {
...
},
// key will transform to path matching, value will transform to target options
"devEnvironments": {
    // String
    "proxies": "http://api.xxx.com",                        // matching 'http://api.xxx.com' to target 'http://api.xxx.com'
    // Object
    "proxies": {
        "/api": "http://api.xxx.com",                       // matching '/api' to target 'http://api.xxx.com'
        "http://api.xxx.com": "http://api.xxx.com",         // matching '/http://api.xxx.com' to target 'http://api.xxx.com'
        "http://api.xxx.com/api": "http://api.xxx.com",     // matching '/http://api.xxx.com/api' to target 'http://api.xxx.com'
        "http://192.168.1.1": "http://api.xxx.com",         // matching '/http://192.168.1.1' to target 'http://api.xxx.com'
        "http://192.168.1.1:8080": "http://api.xxx.com",    // matching '/http://192.168.1.1:8080' to target 'http://api.xxx.com'
        "http://api2.xxx.com": {                            // matching '/http://api2.xxx.com' to target 'http://localhost:3002 with more custom options
            target: "http://localhost:3002"
            (http-proxy-middleware options)...
        }
    },
    // Array
    "proxies": [
        "http://api1.xxxx.com",
        {
            "http://api2.xxxx.com": "http://192.168.1.1:3001",
            "http://api3.xxxx.com": "http://192.168.1.1:3002"
        }, {
            "http://api4.xxx.com": {
                target: "http://192.168.1.1:3003"
                (http-proxy-middleware options)...
            }
        }
    ],
    // use [] to remove content(content which is in [] will replace to '')
    "proxies": {
        "[/proxy]": "http://api.xxx.com",                   // request '/proxy/json/210.75.225.254', matching '/proxy', to 'http://api.xxx.com/json/210.75.225.254'
        "[/proxy]/api": "http://api.xxx.com",               // request '/proxy/api/210.75.225.254', matching '/proxy/api', to 'http://api.xxx.com/api/210.75.225.254'
        "[http://api.xxx.com]": "http://api.xxx.com",       // request '/http://api.xxx.com/api/210.75.225.254', matching 'http://api.xxx.com', to http://api.xxx.com/api/210.75.225.254'
        "[http://api.xxx.com]/api": "http://api.xxx.com"    // request '/http://api.xxx.com/api/210.75.225.254', matching 'http://api.xxx.com/api', to http://api.xxx.com/api/210.75.225.254'
    }
}
...

webpack.config.dev.js

setting options

import { settings } from 'http-proxy-config';
import pkg from './package.json';

const { local, proxies } = pkg.devEnvironments;

{
    devServer: {
        host: '0.0.0.0',
        port: local,
        proxy: {
            ...settings(proxies),
            ...other
        }
    }
    ...
}

rewrite default options of http-proxy-middleware

{
    devServer: {
        host: '0.0.0.0',
        port: local,
        proxy: {
            ...settings(proxies, {
                logLevel: 'info',
                secure: true,
                ws: true
                ...(http-proxy-middleware options)
            }),
            ...other
        }
    }
    ...
}

default options

{
    logLevel: 'debug',
    changeOrigin: true,
    secure: false,
    cookieDomainRewrite: '',
    cookiePathRewrite: '/',
    pathRewrite: pathRewriteWrapper  // pathRewriteWrapper will replace [xxx] to '' which is in path matching, like '[/proxy]' or '[/proxy]/api'
}

API

/**
 * @desc create options for http-proxy-middleware
 * @param {string | array | object} options proxy config.
 * @param {object} default default options.
 * @return {object}
 */
settings(options, default)