@nuxtjs/proxy

proxy support for nuxt server

Stats

StarsIssuesVersionUpdatedCreatedSize
@nuxtjs/proxy
348152.1.09 months ago4 years agoMinified + gzip package size for @nuxtjs/proxy in KB

Readme

@nuxtjs/proxy

npm version npm downloads codecov license

Proxy support for nuxt server

šŸ“– Release Notes

Features

āœ“ Path rewrites

āœ“ Host based router (useful for staging/test)

āœ“ Logs / Proxy Events

āœ“ WebSockets

āœ“ Auth / Cookie

āœ“ ...See http-proxy-middleware docs

āš  Does not work in generated/static mode!

Setup

  1. Add @nuxtjs/proxy dependency to your project
yarn add @nuxtjs/proxy # or npm install @nuxtjs/proxy
  1. 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 Config

You can use shorthand syntax to configure proxy:

{
  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 Config

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

  1. Clone this repository
  2. Install dependencies using yarn install or npm install
  3. Start development server using npm run dev

License

MIT License

Copyright (c) Nuxt Community

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.