REST Hello World!

From 394b4f0bf7f2a4d496ffe69c8e30cff153d69532 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= Date: Thu, 14 Jan 2016 20:00:50 +0100 Subject: Simplify example instructions and fix broken examples Also convert to AsciiDoc while we're at it. --- examples/rest_hello_world/README.asciidoc | 81 +++++++++++++++++++++++++++++ examples/rest_hello_world/README.md | 86 ------------------------------- 2 files changed, 81 insertions(+), 86 deletions(-) create mode 100644 examples/rest_hello_world/README.asciidoc delete mode 100644 examples/rest_hello_world/README.md (limited to 'examples/rest_hello_world') 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 + + + + + REST Hello World! + + +

REST Hello World as 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 + +---- diff --git a/examples/rest_hello_world/README.md b/examples/rest_hello_world/README.md deleted file mode 100644 index c7e124c..0000000 --- a/examples/rest_hello_world/README.md +++ /dev/null @@ -1,86 +0,0 @@ -REST hello world example -======================== - -To try this example, you need GNU `make` and `git` in your PATH. - -To build the example, run the following command: - -``` bash -$ make -``` - -To start the release in the foreground: - -``` bash -$ ./_rel/rest_hello_world_example/bin/rest_hello_world_example console -``` - -Then point your browser at [http://localhost:8080](http://localhost:8080). - -Example output --------------- - -Request 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 -vary: Accept - - - - - REST Hello World! - - -

REST Hello World as HTML!

- - -``` - -Request 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 -vary: Accept - -{"rest": "Hello World!"} -``` - -Request plain 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 -vary: Accept - -REST Hello World as text! -``` - -Request a non acceptable content-type: - -``` 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 - -``` -- cgit v1.2.3