web_api_base 2.5.0 → 2.5.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web_api_base",
-  "version": "2.5.0",
+  "version": "2.5.2",
   "description": "web api base",  
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/readme.md

@@ -14,19 +14,28 @@ npm install web_api_base
 ## Usage
 
 First of all we need implement the abstract class __Application__. 
-After that, we need to create some controllers and, they must inherit  the abstract class __ControllerBase__.
+After that, we need to create some controllers and they must inherit  the abstract class __ControllerBase__.
 
-### SampleController.ts
+### ./controllers/SampleController.ts
 
 ```typescript
 
-import { ControllerBase, ControllersDecorators as CD, HTTPVerbs as verbs } from "web_api_base";
+import { ControllerBase, HTTPVerbs as verbs, Use, Verb, Route, Action } from "web_api_base";
+/*
 
-@CD.Route("/sample")
+we can use this class to acess all decorators centralized
+import { ControllerDecorators as CD } from "web_api_base";
+
+*/
+
+//@CD.Route("/sample")
+@Route("/sample")
 export default class SampleController extends ControllerBase
 {   
-    @CD.Verb(verbs.GET)
-    @CD.Action("/hello")
+    //@CD.Verb(verbs.GET)
+    @Verb(verbs.GET)
+    //@CD.Action("/hello")
+    @Action("/hello")
     public Hello() : void
     {
         this.OK({message: "Hello Word!"})
@@ -48,17 +57,32 @@ export default class App extends Application
     
     public override Configure(appConfig: IApplicationConfiguration): void
     {      
-        appConfig.Host = "0.0.0.0";
-        appConfig.Port = 5555;  
+        //to define the host use this property, if that property is not changed, the default value will be 0.0.0.0
+        appConfig.Host = "127.0.0.1";
+        //to define the app port use this property, if that property is not changed, the default value will be 5555
+        appConfig.Port = 1234;  
        
         //allow CORS
         this.UseCors();
 
         //register in DI service
         DependecyService.Register(SampleController);  
+
+        */
+            if the controlles follow the naming rules, the method UseControllers will automatically append them
+
+            rootDir -
+                     |
+                     | -  controllers -
+                                        | - <Name>Controller.ts
+            |
+            | - App.ts //the class that inherit the Application       
+     
+         */        
+        this.UseControllers();
     
-        //append the controller in the pipe line of requests
-        ControllerBase.AppendController(SampleController,this);  
+        //if not, we can append manually using the method bellow
+        //ControllerBase.AppendController(SampleController,this);  
 
     }  
 }