diff options
author | Loïc Hoguin <[email protected]> | 2016-01-14 20:00:50 +0100 |
---|---|---|
committer | Loïc Hoguin <[email protected]> | 2016-01-14 20:00:50 +0100 |
commit | 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 (patch) | |
tree | 82c3d7634f93596ec42b41050b4130805a359359 /examples/rest_hello_world/README.asciidoc | |
parent | 4023e7f4e429179fd9c2cce4487c33646c6bd327 (diff) | |
download | cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.gz cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.tar.bz2 cowboy-394b4f0bf7f2a4d496ffe69c8e30cff153d69532.zip |
Simplify example instructions and fix broken examples
Also convert to AsciiDoc while we're at it.
Diffstat (limited to 'examples/rest_hello_world/README.asciidoc')
-rw-r--r-- | examples/rest_hello_world/README.asciidoc | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/examples/rest_hello_world/README.asciidoc b/examples/rest_hello_world/README.asciidoc new file mode 100644 index 0000000..5eb94e8 --- /dev/null +++ b/examples/rest_hello_world/README.asciidoc @@ -0,0 +1,81 @@ += REST hello world example + +To try this example, you need GNU `make` and `git` in your PATH. + +To build and run the example, use the following command: + +[source,bash] +$ make run + +Then point your browser to http://localhost:8080 + +== Example output + +Request HTML: + +[source,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 +vary: Accept + +<html> +<head> + <meta charset="utf-8"> + <title>REST Hello World!</title> +</head> +<body> + <p>REST Hello World as HTML!</p> +</body> +</html> +---- + +Request JSON: + +[source,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 +vary: Accept + +{"rest": "Hello World!"} +---- + +Request plain text: + +[source,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 +vary: Accept + +REST Hello World as text! +---- + +Request a non acceptable content-type: + +[source,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 + +---- |