init

Kreta.BusinessLogic/Classes/MobileApi/README.txt

@@ -0,0 +1,60 @@
+Kréta mellé épített Webapi direktívák.
+Készítés dátuma: 2018.06.
+Szerző: Kovács Kornél (DevKornél)
+Copyright © 2018 eKRÉTA Informatikai Zrt.
+===========================================================================
+Projects
+  -Ellenorzo
+  -Naplo
+  
+I. Api version naming convention.
+  -Actual version
+    Endpoint: V{ActualApiVersion as integer}
+    Code:     Vn
+  -Previous versions
+    Endpoint: V{PreviousApiVersion as integer}
+    Code:     V{PreviousApiVersion as integer}
+  
+II. Structure of folders. 
+  ./Root/
+    Common/
+    Naplo/
+    Ellenorzo/
+      {Vx}/
+        Co/
+          Common/
+          Enum/        
+          {RegionName}/
+                      Post/
+                        Get/
+                        Delete/
+                        Put/
+                {ModelName}{OperationName}{Direction}{Suffix} (e.g. ErtekelesGetResponseCo)
+        Converter/
+        Logic/
+        SubqueriesRepo/
+          {RegionName}{Suffix} (e.g. ErtekelesSubqueries) (This contains CRUD actions)
+          UtilityMethods/
+          
+III. Models
+  -The location of the models:
+    Kreta.{ProjectName}.Domain.{Vx}. (e.g. Kreta.Ellenorzo.Domain)
+  -Explicit converters:
+    Everything inside the models.
+    Model -> Co
+    Model <- Co
+  -Explicit converters:
+    Kreta.Ellenorzo.Domain.Vn.Model.Converter.ResponseModelConverter;
+    Kreta.Ellenorzo.Domain.Vn.Model.Converter.RequestModelConverter;
+    
+IV. Structure of the Api. (with an example)
+                            Common
+                            ^
+                        EllenorzoFacadeBase
+                            ^
+                          EllenorzoFacade
+                            ^
+  Endpoint -> Proxy -> EllenorzoVnController -> EllenorzoFacadeVn -> FaliujsagGetSubqueries
+                                  \              \
+                                   \              >> Database/Another business logic functions
+                                    > DiakGetSubqueries    /