update documentation

Author: stratdev3

documentation/docs/.vitepress/config.mjs

@@ -8,6 +8,8 @@ export default defineConfig({
     description: "Simple Web server library in .NET Core",
     head: [
         ['link', { rel: 'icon', href: '/SimpleW/favicon.ico' }]
+        ['script', { async: '', src: 'https://www.googletagmanager.com/gtag/js?id=GTM-PBQ3XQSQ' } ],
+        ['script', {}, `window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'GTM-PBQ3XQSQ');`]
     ],
     themeConfig: {
         // https://vitepress.dev/reference/default-theme-config
@@ -74,6 +76,9 @@ export default defineConfig({
         },
 
     },
+    sitemap: {
+        hostname: 'https://stratdev3.github.io'
+    },
     ignoreDeadLinks: [
         // ignore all localhost links
         /^https?:\/\/localhost/,

documentation/docs/advanced.md

@@ -1,3 +1,49 @@
-# Return Data
+# Advanced
+
+
+#### Catch All Maintenance Page
+
+You can setup a maintenance page to catch all api call by using the wildcard in a ```RouteAttribute```.
+
+```csharp:line-numbers
+using System;
+using System.Net;
+using SimpleW;
+
+namespace Sample {
+    class Program {
+
+        static void Main() {
+
+            // listen to all IPs port 2015
+            var server = new SimpleWServer(IPAddress.Any, 2015);
+
+            // need by MaintenanceController wildcard route parameter
+            server.Router.RegExpEnabled = true;
+            // add the dedidacted controller
+            server.AddDynamicContent(typeof(MaintenanceController), "/api/v1");
+
+            server.Start();
+
+            Console.WriteLine("server started at http://localhost:2015/");
+
+            // block console for debug
+            Console.ReadKey();
+
+        }
+    }
+
+    // inherit from Controller to target a class
+    public class MaintenanceController : Controller {
+
+        // wildcard route parameter will call all string under root api
+        [Route("GET", "/*")]
+        public object Maintenance() {
+            return Response.MakeErrorResponse(503, "Maintenance");
+        }
+
+    }
+
+}
+```
 
-blabla

documentation/docs/api-basic-example.md

@@ -1,12 +1,12 @@
-# Basic Exemple
+# Basic Example
 
 
 The RestAPI is based on **routes**, so just add a `RouteAttribute` to target **methods** of a `Controller` base class.<br />
 The return is serialized into json and sent as a response to the client.
 
 Use `server.AddDynamicContent()` to handle RestAPI.
 
-```csharp
+```csharp:line-numbers
 using System;
 using System.Net;
 using SimpleW;

documentation/docs/api-cors.md

@@ -1,3 +1,46 @@
 # CORS
 
-blabla
+
+Internet Browser (Firefox, Chrome, IE...) blocks javascript requesting RestAPI from a different domain. That's why [CORS](https://developer.mozilla.org/fr/docs/Web/HTTP/CORS) was created, to define permission and sharing data.
+
+To set CORS policy, use the `server.AddCORS()` method :
+
+```csharp:line-numbers
+using System;
+using System.Net;
+using SimpleW;
+
+namespace Sample {
+    class Program {
+
+        static void Main() {
+            var server = new SimpleWServer(IPAddress.Any, 2015);
+            server.AddDynamicContent("/api");
+
+            // set CORS policy
+            server.AddCORS(
+                "*",                // Access-Control-Allow-Origin
+                "*",                // Access-Control-Allow-Headers
+                "GET,POST,OPTIONS", // Access-Control-Allow-Methods
+                "true"              // Access-Control-Allow-Credentials
+            );
+
+            server.Start();
+            Console.WriteLine("server started at http://localhost:2015/");
+            Console.ReadKey();
+        }
+    }
+
+    public class SomeController : Controller {
+
+        [Route("GET", "/test")]
+        public object SomePublicMethod() {
+            return new {
+                message = "Hello World !"
+            };
+        }
+
+    }
+
+}
+```

documentation/docs/api-hook.md

@@ -1,3 +1,152 @@
 # Hook
 
-blabla
+
+There are some places where SimpleW behavior can be overridden.
+
+#### OnBeforeMethod
+
+The `Controller` class contains an abstract method `OnBeforeMethod()` which is called before any method execution.
+
+```csharp:line-numbers
+using System;
+using System.Net;
+using SimpleW;
+
+namespace Sample {
+
+    class Program {
+        static void Main() {
+            var server = new SimpleWServer(IPAddress.Any, 2015);
+            server.AddDynamicContent("/api");
+            server.Start();
+            Console.WriteLine("server started at http://localhost:2015/");
+            Console.ReadKey();
+        }
+    }
+
+    [Route("/test")]
+    public class TestController : Controller {
+
+        // Router will call this methods before another one
+        public override void OnBeforeMethod() {
+            Console.WriteLine("OnBeforeMethod()");
+        }
+
+        [Route("GET", "/index")]
+        public object Index() {
+            return "test index page";
+        }
+
+        [Route("POST", "/create")]
+        public object Create() {
+            return "test create success";
+        }
+
+    }
+
+}
+```
+
+
+#### Subclass
+
+A better approach for adding some logic code to all your controllers is by extending the `Controller` class.
+
+Example using a `BaseController` class that contains common code to all controllers.
+
+```csharp:line-numbers
+using System;
+using System.Net;
+using SimpleW;
+
+namespace Sample {
+
+    class Program {
+        static void Main() {
+            var server = new SimpleWServer(IPAddress.Any, 2015);
+            server.AddDynamicContent("/api");
+            server.Start();
+            Console.WriteLine("server started at http://localhost:2015/");
+            Console.ReadKey();
+        }
+    }
+
+    class BaseController : Controller {
+
+        // example of property used in subclass
+        protected Repository _repo = new();
+
+    }
+
+    [Route("/user")]
+    class UserController : BaseController {
+
+        [Route("GET", "/index")]
+        public object Index() {
+            var users = _repo.GetAll<User>();
+            return users;
+        }
+
+    }
+
+    [Route("/department")]
+    class DepartmentController : BaseController {
+
+        [Route("GET", "/index")]
+        public object Index() {
+            var departments = _repo.GetAll<Department>();
+            return departments;
+        }
+
+    }
+
+}
+```
+
+The subclass can contains route's method too. To avoid this subclass being parsed by the router, it must be excluded. Use the `AddDynamicContent()` exclude parameter.
+
+```csharp:line-numbers
+using System;
+using System.Net;
+using SimpleW;
+
+namespace Sample {
+
+    class Program {
+        static void Main() {
+            var server = new SimpleWServer(IPAddress.Any, 2015);
+
+            // exclude BaseController as a regular Controller
+            server.AddDynamicContent("/api", new Type[] { typeof(BaseController) });
+
+            server.Start();
+            Console.WriteLine("server started at http://localhost:2015/");
+            Console.ReadKey();
+        }
+    }
+
+    class BaseController : Controller {
+
+        [Route("GET", "/conf")]
+        public object Conf() {
+            return "conf";
+        }
+
+    }
+
+    [Route("/user")]
+    class UserController : BaseController {
+
+    }
+
+    [Route("/department")]
+    class DepartmentController : BaseController {
+
+    }
+
+}
+```
+
+Note : the method `BaseController.Conf()` with its `Route` attribute is shared across all controllers. It can be access through :
+- http://localhost:2015/api/user/conf
+- http://localhost:2015/api/department/conf