Merge pull request #72 from anton-k/hw-pragma

Update hello world examples

README.md

@@ -16,6 +16,8 @@ With the library [`mig-server`](https://hackage.haskell.org/package/mig-server)
 a simple server with two routes:
 
 ```haskell
+{-# Language OverloadedStrings #-}
+
 import Mig.Json.IO
 
 -- | Starts server on port 8085.
@@ -34,7 +36,7 @@ server =
 hello :: Get (Resp Text)
 hello = pure $ ok "Hello World"
 
--- | The handler definition as a function with a query parameter to ask for user name
+-- | The handler definition as a function with a query parameter to ask for the user name
 bye :: Query "user" Text -> Get (Resp Text)
 bye (Query name) = pure $ ok ("Goodbye " <> name)
 ```

docs/src/00-foreword.md

@@ -19,8 +19,9 @@ The main features of the mig library are:
 
 Example of hello world server:
 
-
 ```haskell
+{-# Language OverloadedStrings #-}
+
 import Mig.Json.IO
 
 -- | Starts server on port 8085.
@@ -29,13 +30,20 @@ main = runServer 8085 server
 
 -- | The server definition
 server :: Server IO
-server = "api/v1/hello" /. hello
+server = 
+  "api/v1" /. 
+    [ "hello" /. hello
+    , "bye" /. bye
+    ]
 
 -- | The handler definition as a function
 hello :: Get (Resp Text)
 hello = pure $ ok "Hello World"
-```
 
+-- | The handler with a query parameter to ask for the user name
+bye :: Query "user" Text -> Get (Resp Text)
+bye (Query name) = pure $ ok ("Goodbye " <> name)
+```
 
 ## How to install library
 

examples/mig-example-apps/HelloWorld/Main.hs

@@ -1,28 +1,25 @@
-{-| Most basic Hello world server.
-It has only one route which outputs the greeting to the user
--}
-module Main (
-  main,
-) where
+{-# LANGUAGE OverloadedStrings #-}
 
-import Mig
+-- \| Most basic Hello world server.
+-- It has only two routes which output the text as JSON to the user
+import Mig.Json.IO
 
-{-| We can render the server and run it on port 8085.
-It uses wai and warp.
--}
+-- | Starts server on port 8085.
 main :: IO ()
-main = do
-  putStrLn ("The hello world server listens on port: " <> show port)
-  runServer port server
-  where
-    port = 8085
+main = runServer 8085 (withSwagger def server)
 
-{-| Init simple hello world server which
-replies on a single route
--}
+-- | The server definition with two routes
 server :: Server IO
-server = "api/v1/hello" /. hello
+server =
+  "api/v1"
+    /. [ "hello" /. hello
+       , "bye" /. bye
+       ]
 
--- | Handler takes no inputs and marked as Get HTTP-request that returns Text response as Json.
-hello :: Get IO (Resp Json Text)
-hello = pure $ ok "Hello World!"
+-- | The handler definition as a function
+hello :: Get (Resp Text)
+hello = pure $ ok "Hello World"
+
+-- | The handler definition as a function with a query parameter to ask for the user name
+bye :: Query "user" Text -> Get (Resp Text)
+bye (Query name) = pure $ ok ("Goodbye " <> name)