mirror of https://github.com/ninenines/cowboy.git synced 2025-07-14 20:30:23 +00:00

Loïc Hoguin f1c3b6d76f Breaking update of the cowboy_req interface Simplify the interface for most cowboy_req functions. They all return a single value except the four body reading functions. The reply functions now only return a Req value. Access functions do not return a Req anymore. Functions that used to cache results do not have a cache anymore. The interface for accessing query string and cookies has therefore been changed. There are now three query string functions: qs/1 provides access to the raw query string value; parse_qs/1 returns the query string as a list of key/values; match_qs/2 returns a map containing the values requested in the second argument, after applying constraints and default value. Similarly, there are two cookie functions: parse_cookies/1 and match_cookies/2. More match functions will be added in future commits. None of the functions return an error tuple anymore. It either works or crashes. Cowboy will attempt to provide an appropriate status code in the response of crashed handlers. As a result, the content decode function has its return value changed to a simple binary, and the body reading functions only return on success.		2014-09-23 16:43:29 +03:00
..
src	Breaking update of the cowboy_req interface	2014-09-23 16:43:29 +03:00
Makefile	Update to erlang.mk 1.0.0	2014-08-01 14:26:51 +02:00
README.md	Update erlang.mk and update paths to start the release	2014-06-30 10:14:05 +02:00
relx.config	Convert the REST streaming example to a release	2013-09-08 19:50:31 +02:00

README.md

REST streaming example

To try this example, you need GNU make and git in your PATH.

To build the example, run the following command:

$ make

To start the release in the foreground:

$ ./_rel/rest_stream_response_example/bin/rest_stream_response_example console

Then point your browser at http://localhost:8080.

About

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.

Example output

Fetch records with the second field with value 1:

$ 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
...

Fetch records with the second field with value 4:

$ 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
...

Fail to use a proper integer and get an error:

$ 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