diff options
| author | Josh Toft <[email protected]> | 2012-09-27 21:32:11 -0700 |
|---|---|---|
| committer | Josh Toft <[email protected]> | 2012-10-01 10:37:24 -0700 |
| commit | 855828d15cdeea343ba499071c14caaeeec19dab (patch) | |
| tree | cfce1e77220417aee439aa95412fa0e59b7fe452 /examples/rest_hello_world | |
| parent | 0b82eebed654bd894802acb52697a4d4187cb228 (diff) | |
| download | cowboy-855828d15cdeea343ba499071c14caaeeec19dab.tar.gz cowboy-855828d15cdeea343ba499071c14caaeeec19dab.tar.bz2 cowboy-855828d15cdeea343ba499071c14caaeeec19dab.zip | |
Make example README's more thorough
Diffstat (limited to 'examples/rest_hello_world')
| -rw-r--r-- | examples/rest_hello_world/README.md | 71 |
1 files changed, 69 insertions, 2 deletions
diff --git a/examples/rest_hello_world/README.md b/examples/rest_hello_world/README.md index 6b62bd7..c0b8c8d 100644 --- a/examples/rest_hello_world/README.md +++ b/examples/rest_hello_world/README.md @@ -1,5 +1,5 @@ -Cowboy Hello World -================== +Cowboy Rest Hello World +======================= To compile this example you need rebar in your PATH. @@ -14,3 +14,70 @@ You can then start the Erlang node with the following command: ``` Then run any given command or point your browser to the indicated URL. + +Examples +-------- + +### Get HTML + +``` bash +$ curl -i http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:15:52 GMT +content-length: 136 +Content-Type: text/html +Variances: Accept + +<html> +<head> + <meta charset="utf-8"> + <title>REST Hello World!</title> +</head> +<body> + <p>REST Hello World as HTML!</p> +</body> +</html> +``` + +### Get JSON + +``` bash +$ curl -i -H "Accept: application/json" http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:16:46 GMT +content-length: 24 +Content-Type: application/json +Variances: Accept + +{"rest": "Hello World!"} +``` + +### Get text + +``` bash +$ curl -i -H "Accept: text/plain" http://localhost:8080 +HTTP/1.1 200 OK +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:18:35 GMT +content-length: 25 +Content-Type: text/plain +Variances: Accept + +REST Hello World as text! +``` + +### Get a 406 +``` bash +$ curl -i -H "Accept: text/css" http://localhost:8080 +HTTP/1.1 406 Not Acceptable +connection: keep-alive +server: Cowboy +date: Fri, 28 Sep 2012 04:18:51 GMT +content-length: 0 + +``` |