From efd7bdb54e42adc34619f8094a0d5aa378db2d4a Mon Sep 17 00:00:00 2001
From: jie <jonathansilver@126.com>
Date: Thu, 21 Oct 2021 22:04:25 +0800
Subject: [PATCH] add examples: routing

---
 README.md                                    | 75 +++++++++++++++-----
 examples/{hello-world => }/.gitignore        |  0
 examples/CMakeLists.txt                      | 14 ++++
 examples/hello-world/CMakeLists.txt          | 10 ---
 examples/{hello-world/main.cpp => hello.cpp} |  0
 examples/routing.cpp                         | 38 ++++++++++
 6 files changed, 111 insertions(+), 26 deletions(-)
 rename examples/{hello-world => }/.gitignore (100%)
 create mode 100644 examples/CMakeLists.txt
 delete mode 100644 examples/hello-world/CMakeLists.txt
 rename examples/{hello-world/main.cpp => hello.cpp} (100%)
 create mode 100644 examples/routing.cpp

diff --git a/README.md b/README.md
index a5efe55..dd8a040 100644
--- a/README.md
+++ b/README.md
@@ -2,19 +2,18 @@
 
 *A Boost Based C++ HTTP JSON Server.*
 
+> NOTE:
+> - To build the dependencies & the project, refer to [`BUILD-Windows.md`](BUILD-Windows.md) or [`BUILD-ubuntu.md`](BUILD-ubuntu.md).
+> - `WebApp/bserv` contains the source code for `bserv`.
+
 
 ## Quick Start
 
-> To build the dependencies & the project, refer to [`BUILD-Windows.md`](BUILD-Windows.md) or [`BUILD-ubuntu.md`](BUILD-ubuntu.md).
-
-- `WebApp/bserv` contains the source code for `bserv`.
-
+> [`examples/CMakeLists.txt`](examples/CMakeLists.txt) can be used to compile all the examples.
 
 ### Hello, World!
 
-*This [example](examples/hello-world) shows how to use `bserv` to echo a json object `{"msg": "hello, world!"}` when requesting `localhost:8080/hello`.*
-
-`main.cpp`:
+[`hello.cpp`](examples/hello.cpp):
 ```C++
 #include <bserv/common.hpp>
 #include <boost/json.hpp>
@@ -32,19 +31,63 @@ int main()
 }
 ```
 
-`CMakeLists.txt`:
+By default, `bserv` listens to `8080`. When you make a request (of any type) to `localhost:8080/hello`, it will respond: `{"msg": "hello, world!"}`.
+
+
+### Routing
+
+[`routing.cpp`](examples/routing.cpp):
+```C++
+#include <bserv/common.hpp>
+#include <boost/json.hpp>
+#include <string>
+boost::json::object greet(
+	const std::string& name)
+{
+	return {{"hello", name}};
+}
+boost::json::object greet2(
+	const std::string& name1,
+	const std::string& name2)
+{
+	return {
+		{"name1", name1},
+		{"name2", name2}
+	};
+}
+boost::json::object echo(
+	boost::json::object&& params)
+{
+	return params;
+}
+int main()
+{
+	bserv::server_config config;
+	bserv::server{config, {
+		bserv::make_path(
+			"/greet/<str>", &greet,
+			bserv::placeholders::_1),
+		bserv::make_path(
+			"/greet/<str>/and/<str>", &greet2,
+			bserv::placeholders::_1,
+			bserv::placeholders::_2),
+		bserv::make_path(
+			"/echo", &echo,
+			bserv::placeholders::json_params)
+	}};
+}
 ```
-cmake_minimum_required(VERSION 3.10)
 
-project(hello)
+The following table shows some requests & responses:
 
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
+|Method|URL|Request Body|Response Body|
+|:-:|:-:|:-:|:-:|
+|Any|`/greet/world`|(Empty)|`{"hello": "world"}`|
+|Any|`/greet/world1/and/world2`|(Empty)|`{"name1": "world1", "name2": "world2"}`|
+|GET|`/echo?hello=world`|(Empty)|`{"hello": "world"}`|
+|POST|`/echo`|`{"hello": "world"}`|`{"hello": "world"}`|
 
-add_subdirectory(path/to/WebApp/bserv bserv)
-add_executable(main main.cpp)
-target_link_libraries(main PUBLIC bserv)
-```
+*All of the URLs should be prefixed with `localhost:8080` when you make the requests.*
 
 
 ### Sample Project: `WebApp`
diff --git a/examples/hello-world/.gitignore b/examples/.gitignore
similarity index 100%
rename from examples/hello-world/.gitignore
rename to examples/.gitignore
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
new file mode 100644
index 0000000..4a83d9a
--- /dev/null
+++ b/examples/CMakeLists.txt
@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.10)
+
+project(bserv_examples)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+add_subdirectory(../WebApp/bserv bserv)
+
+add_executable(hello hello.cpp)
+target_link_libraries(hello PUBLIC bserv)
+
+add_executable(routing routing.cpp)
+target_link_libraries(routing PUBLIC bserv)
diff --git a/examples/hello-world/CMakeLists.txt b/examples/hello-world/CMakeLists.txt
deleted file mode 100644
index 4d28eab..0000000
--- a/examples/hello-world/CMakeLists.txt
+++ /dev/null
@@ -1,10 +0,0 @@
-cmake_minimum_required(VERSION 3.10)
-
-project(hello)
-
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-
-add_subdirectory(../../WebApp/bserv bserv)
-add_executable(main main.cpp)
-target_link_libraries(main PUBLIC bserv)
diff --git a/examples/hello-world/main.cpp b/examples/hello.cpp
similarity index 100%
rename from examples/hello-world/main.cpp
rename to examples/hello.cpp
diff --git a/examples/routing.cpp b/examples/routing.cpp
new file mode 100644
index 0000000..5c01a62
--- /dev/null
+++ b/examples/routing.cpp
@@ -0,0 +1,38 @@
+#include <bserv/common.hpp>
+#include <boost/json.hpp>
+#include <string>
+boost::json::object greet(
+	const std::string& name)
+{
+	return {{"hello", name}};
+}
+boost::json::object greet2(
+	const std::string& name1,
+	const std::string& name2)
+{
+	return {
+		{"name1", name1},
+		{"name2", name2}
+	};
+}
+boost::json::object echo(
+	boost::json::object&& params)
+{
+	return params;
+}
+int main()
+{
+	bserv::server_config config;
+	bserv::server{config, {
+		bserv::make_path(
+			"/greet/<str>", &greet,
+			bserv::placeholders::_1),
+		bserv::make_path(
+			"/greet/<str>/and/<str>", &greet2,
+			bserv::placeholders::_1,
+			bserv::placeholders::_2),
+		bserv::make_path(
+			"/echo", &echo,
+			bserv::placeholders::json_params)
+	}};
+}