Proxy Module
The one-liner node.js http-proxy middleware solution for Nuxt.js using
http-proxy-middleware
📖 Release Notes
✨ Do you know that Axios Module has built in support for Proxy Module?
Features
✓ Path rewrites
✓ Host based router (useful for staging/test)
✓ Logs / Proxy Events
✓ WebSockets
✓ Auth / Cookie
✓ ...and more! (see http-proxy-middleware docs)
⚠ Does not work in generated/static mode!
Setup
- Add
@nuxtjs/proxy
dependency using yarn or npm to your project - Add
@nuxtjs/proxy
to modules
section of nuxt.config.js
{
modules: [
'@nuxtjs/proxy',
['@nuxtjs/proxy', { pathRewrite: { '^/api' : '/api/v1' } }],
]
}
- Define as many as proxy middleware you want in
proxy
section of nuxt.config.js
(See proxy section below)
Options
changeOrigin
and ws
options are enabled by default.
[optional] You can provide default options to all proxy targets by passing options to module options.
proxy
You can provide proxy config using either object or array.
Array mode
You can use magic shorthands
{
proxy: [
'http://example.com/foo',
'http://example.com:8000/api/books/*/**.json',
[ 'http://example.com/foo', { ws: false } ]
]
}
Object mode
Keys are context
{
proxy: {
'/api': 'http://example.com',
'/api2': { target: 'http://example.com', ws: false }
}
}
License
MIT License
Copyright (c) Nuxt Community - Pooya Parsa pooya@pi0.ir