platform/README.md

34 lines
1 KiB
Markdown
Raw Normal View History

2017-09-24 18:49:18 +00:00
# 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)
2016-11-23 22:03:06 +00:00
2017-09-24 18:49:18 +00:00
Angel middleware to forward requests to another server (i.e. `pub serve`).
2016-11-23 22:03:06 +00:00
```dart
import 'package:angel_proxy/angel_proxy.dart';
2017-09-24 18:49:18 +00:00
import 'package:http/http.dart' as http;
2016-11-23 22:03:06 +00:00
main() async {
// ...
2017-09-24 18:49:18 +00:00
var client = new http.Client();
var proxy = new Proxy(app, client, 'http://localhost:3000');
2016-11-23 22:03:06 +00:00
2017-09-24 18:49:18 +00:00
// Forward requests instead of serving statically
app.use(proxy.handleRequest);
2016-11-23 22:03:06 +00:00
}
2017-04-02 02:06:27 +00:00
```
2017-09-24 18:49:18 +00:00
You can also restrict the proxy to serving only from a specific root:
```dart
new Proxy(app, client, '<host>', publicPath: '/remote');
```
Also, you can map requests to a root path on the remote server
```dart
new Proxy(app, client, '<host>', mapTo: '/path');
```
2017-04-02 02:06:27 +00:00
If your app's `storeOriginalBuffer` is `true`, then request bodies will be forwarded
2017-04-10 02:15:45 +00:00
as well, if they are not empty. This allows things like POST requests to function.