Skip to content

Update proxying-api-requests-in-development.md #8429

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update proxying-api-requests-in-development.md #8429

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d51b626
Update proxying-api-requests-in-development.md
chybisov Feb 5, 2020
fcf3021
Update http-proxy-middleware imports as of v1.0.0
chybisov Feb 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions docusaurus/docs/proxying-api-requests-in-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ $ yarn add http-proxy-middleware
Next, create `src/setupProxy.js` and place the following contents in it:

```js
const proxy = require('http-proxy-middleware');
const { createProxyMiddleware } = require('http-proxy-middleware');

module.exports = function(app) {
// ...
Expand All @@ -95,21 +95,27 @@ module.exports = function(app) {
You can now register proxies as you wish! Here's an example using the above `http-proxy-middleware`:

```js
const proxy = require('http-proxy-middleware');
const { createProxyMiddleware } = require('http-proxy-middleware');

module.exports = function(app) {
app.use(
'/api',
proxy({
//http requests
app.use('/api', createProxyMiddleware('/api', {
target: 'http://localhost:5000',
changeOrigin: true,
})
);
//websocket requests
app.use('/ws', createProxyMiddleware('/ws', {
target: 'http://localhost:5000',
changeOrigin: true,
ws: true
})
);
};
```

> **Note:** You do not need to import this file anywhere. It is automatically registered when you start the development server.

> **Note:** This file only supports Node's JavaScript syntax. Be sure to only use supported language features (i.e. no support for Flow, ES Modules, etc).

> **Note:** Passing the path to the proxy function allows you to use globbing and/or pattern matching on the path, which is more flexible than the express route matching.
> **Note:** Passing the path to the createProxyMiddleware function allows you to use globbing and/or pattern matching on the path, which is more flexible than the express route matching.