aboutsummaryrefslogtreecommitdiffstats
path: root/examples/rest_hello_world/README.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/rest_hello_world/README.asciidoc')
-rw-r--r--examples/rest_hello_world/README.asciidoc81
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
+
+----