Refactor and add docs

Author: SOHELAHMED7

README.md

@@ -382,6 +382,7 @@ Generated URL rules config for above is (in `urls.rest.php` or pertinent file):
     'POST a1/b1' => 'abc/xyz',    
     'a1/b1' => 'abc/options',
 ```
+`x-route` does not support [Yii Modules](https://www.yiiframework.com/doc/guide/2.0/en/structure-modules).
 
 ## Many-to-Many relation definition
 

src/generator/ApiGenerator.php

@@ -474,7 +474,7 @@ public function generate():array
         $urlRulesGenerator = Yii::createObject(UrlRulesGenerator::class, [$config, $actions]);
         $files = $urlRulesGenerator->generate();
 
-        $actions = static::removeDuplicateActions($actions);
+        $actions = static::removeDuplicateActions($actions); // in case of non-crud actions having custom route `x-route` set
         $controllersGenerator = Yii::createObject(ControllersGenerator::class, [$config, $actions]);
         $files->merge($controllersGenerator->generate());
 

src/lib/generators/RestActionGenerator.php

@@ -79,19 +79,19 @@ protected function resolvePath(string $path, PathItem $pathItem):array
             }
 
             // TODO rename
-            $actionHere = $this->prepareAction($method, $operation, $routeData, $customRoute);
+            $action = $this->prepareAction($method, $operation, $routeData, $customRoute);
             if ($customRoute !== null) {
                 if (in_array($customRoute, array_keys($this->allCustomRoutes))) {
-                    $actionHere->isDuplicate = true;
-                    if ($actionHere->params !== $this->allCustomRoutes[$customRoute]) {
+                    $action->isDuplicate = true;
+                    if ($action->params !== $this->allCustomRoutes[$customRoute]) {
                         $this->allCustomRoutes[$customRoute]->isOriginalForCustomRoute = true;
                     }
                 } else {
-                    $actionHere->isDuplicate = false;
-                    $this->allCustomRoutes[$customRoute] = $actionHere;
+                    $action->isDuplicate = false;
+                    $this->allCustomRoutes[$customRoute] = $action;
                 }
             }
-            $actions[] = $actionHere;
+            $actions[] = $action;
         }
         return $actions;
     }

src/lib/items/RestAction.php

@@ -71,13 +71,19 @@ final class RestAction extends BaseObject
     /**
      * @var bool
      * @see $isDuplicate
+     * https://github.com/cebe/yii2-openapi/issues/84
+     * see `x-route` in README.md
+     * Used for generating only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`.
+     * This is used to flag first of one or more duplicates
      */
     public $isOriginalForCustomRoute = false;
+
     /**
      * @var bool
      * https://github.com/cebe/yii2-openapi/issues/84
-     * Generate only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}`.
+     * Generate only one action for paths like: `GET /calendar/domains` and `GET /calendar/domains/{id}` given that they have same `x-route`.
      * @see $isOriginalForCustomRoute
+     * see `x-route` in README.md
      */
     public $isDuplicate = false;