platform/packages/proxy/README.md
Tobe O dd33154af1 Add 'packages/proxy/' from commit 'daca263062d471ae007730fa8ecf854c09c746f8'
git-subtree-dir: packages/proxy
git-subtree-mainline: ee512d5ccf
git-subtree-split: daca263062
2020-02-15 18:22:25 -05:00

34 lines
No EOL
1.1 KiB
Markdown

# proxy
[![Pub](https://img.shields.io/pub/v/angel_proxy.svg)](https://pub.dartlang.org/packages/angel_proxy)
[![build status](https://travis-ci.org/angel-dart/proxy.svg)](https://travis-ci.org/angel-dart/proxy)
Angel middleware to forward requests to another server (i.e. `webdev serve`).
Also supports WebSockets.
```dart
import 'package:angel_proxy/angel_proxy.dart';
import 'package:http/http.dart' as http;
main() async {
// Forward requests instead of serving statically.
// You can also pass a URI, instead of a string.
var proxy1 = Proxy('http://localhost:3000');
// handle all methods (GET, POST, ...)
app.fallback(proxy.handleRequest);
}
```
You can also restrict the proxy to serving only from a specific root:
```dart
Proxy(baseUrl, publicPath: '/remote');
```
Also, you can map requests to a root path on the remote server:
```dart
Proxy(baseUrl.replace(path: '/path'));
```
Request bodies will be forwarded as well, if they are not empty. This allows things like POST requests to function.
For a request body to be forwarded, the body must not have already been parsed.