The one-liner node.js http-proxy middleware solution for Nuxt.js using http-proxy-middleware
Switch branches/tags
Clone or download
Latest commit ff3a8ea Mar 31, 2018

README.md

Proxy Module

npm (scoped with tag) npm CircleCI Codecov Dependencies js-standard-style

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)

Setup

  • Add @nuxtjs/proxy dependency using yarn or npm to your project
  • Add @nuxtjs/proxy to 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 }
  }
}

License

MIT License

Copyright (c) Nuxt Community - Pooya Parsa pooya@pi0.ir