diff options
author | Adam Cammack <[email protected]> | 2013-02-10 13:54:51 -0600 |
---|---|---|
committer | Adam Cammack <[email protected]> | 2013-02-12 09:44:26 -0600 |
commit | f9dd3c9e54da7690db6f936d644c1c7b88ac6e9b (patch) | |
tree | 743c6b84d3429d163fbcaca083e3c6d211f35085 /examples/rest_stream_response/README.md | |
parent | bce7b860ee925b61fe8aa14565301c3c4aa65de2 (diff) | |
download | cowboy-f9dd3c9e54da7690db6f936d644c1c7b88ac6e9b.tar.gz cowboy-f9dd3c9e54da7690db6f936d644c1c7b88ac6e9b.tar.bz2 cowboy-f9dd3c9e54da7690db6f936d644c1c7b88ac6e9b.zip |
Add a REST example that streams its response
Diffstat (limited to 'examples/rest_stream_response/README.md')
-rw-r--r-- | examples/rest_stream_response/README.md | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/examples/rest_stream_response/README.md b/examples/rest_stream_response/README.md new file mode 100644 index 0000000..70e1ba7 --- /dev/null +++ b/examples/rest_stream_response/README.md @@ -0,0 +1,66 @@ +Cowboy REST Streaming Responses +=============================== + +To compile this example you need rebar in your PATH. + +Type the following command: +``` +$ rebar get-deps compile +``` + +You can then start the Erlang node with the following command: +``` +./start.sh +``` + +This example simulates streaming a large amount of data from a data store one +record at a time in CSV format. It also uses a constraint to ensure that the +last segment of the route is an integer. + +Examples +-------- + +### Get records with a field 2 value of 1 + +``` bash +$ curl -i localhost:8080 +HTTP/1.1 200 OK +transfer-encoding: identity +server: Cowboy +date: Sun, 10 Feb 2013 19:32:16 GMT +connection: close +content-type: text/csv + +DBUZGQ0C,1,28 +BgoQAxMV,1,6 +DAYEFxER,1,18 +... +``` + +### Get records with a field 2 value of 4 + +``` bash +$ curl -i localhost:8080/4 +HTTP/1.1 200 OK +transfer-encoding: identity +server: Cowboy +date: Sun, 10 Feb 2013 19:34:31 GMT +connection: close +content-type: text/csv + +ABcFDxcE,4,42 +DgYQCgEE,4,5 +CA8BBhYD,4,10 +... +``` + +### Get a 404 + +``` bash +$ curl -i localhost:8080/foo +HTTP/1.1 404 Not Found +connection: keep-alive +server: Cowboy +date: Sun, 10 Feb 2013 19:36:16 GMT +content-length: 0 +``` |