The one-liner node.js http-proxy middleware solution for Nuxt.js using http-proxy-middleware
โจ Do you know that Axios Module has built in support for Proxy Module?
โ 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!
- Add
@nuxtjs/proxy
dependency to your project
yarn add @nuxtjs/proxy # or npm install @nuxtjs/proxy
- Add
@nuxtjs/proxy
to themodules
section ofnuxt.config.js
{
modules: [
// Simple usage
'@nuxtjs/proxy',
// With options
['@nuxtjs/proxy', { pathRewrite: { '^/api' : '/api/v1' } }]
]
}
- Define as many as proxy middleware you want in
proxy
section ofnuxt.config.js
(See proxy section below)
changeOrigin
andws
options are enabled by default.
[optional] You can provide default options to all proxy targets by passing options to module options.
You can provide proxy config using either object or array.
You can use magic shorthands
{
proxy: [
// Proxies /foo to http://example.com/foo
'http://example.com/foo',
// Proxies /api/books/*/**.json to http://example.com:8000
'http://example.com:8000/api/books/*/**.json',
// You can also pass more options
[ 'http://example.com/foo', { ws: false } ]
]
}
Keys are context
{
proxy: {
// Simple proxy
'/api': 'http://example.com',
// With options
'/api2': { target: 'http://example.com', ws: false },
// Proxy to backend unix socket
'/api3': {
changeOrigin: false,
target: { socketPath: '/var/run/http-sockets/backend.sock' }
}
}
}
- Clone this repository
- Install dependencies using
yarn install
ornpm install
- Start development server using
npm run dev
Copyright (c) Nuxt Community