@nuxtjs/proxy

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 to your project

yarn add @nuxtjs/proxy # or npm install @nuxtjs/proxy

Add @nuxtjs/proxy to the modules section of nuxt.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 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: [
    // 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 } ]
  ]
}

Object mode

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' }
    }
  }
}

Development

Clone this repository
Install dependencies using yarn install or npm install
Start development server using npm run dev

License

MIT License

3.4 KiB Executable File Raw Blame History