Fix this issue

Author: SOHELAHMED7

README.md

@@ -309,6 +309,11 @@ Provide custom database table column name in case of relationship column. This w
               - x-fk-column-name: redelivery_of # this will create `redelivery_of` column instead of `redelivery_of_id`
 ```
 
+### `x-route`
+
+https://github.com/cebe/yii2-openapi/issues/144
+TODO
+
 ## Many-to-Many relation definition
 
 There are two ways for define many-to-many relations:

src/lib/CustomSpecAttr.php

@@ -40,4 +40,9 @@ class CustomSpecAttr
      * Foreign key column name. See README for usage docs
      */
     public const FK_COLUMN_NAME = 'x-fk-column-name';
+
+    /**
+     * Custom route (controller ID/action ID) instead of auto-generated. See README for usage docs. https://github.com/cebe/yii2-openapi/issues/144
+     */
+    public const ROUTE = 'x-route';
 }

src/lib/generators/RestActionGenerator.php

@@ -11,6 +11,7 @@
 use cebe\openapi\spec\PathItem;
 use cebe\openapi\spec\Reference;
 use cebe\yii2openapi\lib\Config;
+use cebe\yii2openapi\lib\CustomSpecAttr;
 use cebe\yii2openapi\lib\items\RestAction;
 use cebe\yii2openapi\lib\items\RouteData;
 use cebe\yii2openapi\lib\openapi\ResponseSchema;
@@ -44,6 +45,11 @@ public function generate():array
     {
         $actions = [];
         foreach ($this->config->getOpenApi()->paths as $path => $pathItem) {
+            $customRoute = null;
+            if (isset($pathItem->{CustomSpecAttr::ROUTE})) { # https://github.com/cebe/yii2-openapi/issues/144
+                $customRoute = $pathItem->{CustomSpecAttr::ROUTE};
+            }
+
             if ($path[0] !== '/') {
                 throw new InvalidConfigException('Path must begin with /');
             }
@@ -53,7 +59,7 @@ public function generate():array
             if ($pathItem instanceof Reference) {
                 $pathItem = $pathItem->resolve();
             }
-            $actions[] = $this->resolvePath($path, $pathItem);
+            $actions[] = $this->resolvePath(!empty($customRoute) ? '/' . $customRoute : $path, $pathItem);
         }
         return array_merge(...$actions);
     }

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/config/urls.rest.php

@@ -0,0 +1,15 @@
+<?php
+/**
+ * OpenAPI UrlRules
+ *
+ * This file is auto generated.
+ */
+return [
+    'POST payments/invoice/<invoice:\d+>' => 'payments/create-invoice',
+    'GET payments/invoice-payment' => 'payment/invoice-payment',
+    'GET abc/xyz' => 'abc/xyz',
+    'POST abc/xyz' => 'abc/create-xyz',
+    'payments/invoice/<invoice:\d+>' => 'payments/options',
+    'payments/invoice-payment' => 'payment/options',
+    'abc/xyz' => 'abc/options',
+];

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/AbcController.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace app\controllers;
+
+class AbcController extends \app\controllers\base\AbcController
+{
+
+    public function checkAccess($action, $model = null, $params = [])
+    {
+        //TODO implement checkAccess
+    }
+
+    public function actionXyz()
+    {
+        //TODO implement actionXyz
+    }
+
+    public function actionCreateXyz()
+    {
+        //TODO implement actionCreateXyz
+    }
+
+
+}
+

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/PaymentController.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace app\controllers;
+
+class PaymentController extends \app\controllers\base\PaymentController
+{
+
+    public function checkAccess($action, $model = null, $params = [])
+    {
+        //TODO implement checkAccess
+    }
+
+    public function actionInvoicePayment()
+    {
+        //TODO implement actionInvoicePayment
+    }
+
+
+}
+

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/PaymentsController.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace app\controllers;
+
+class PaymentsController extends \app\controllers\base\PaymentsController
+{
+
+    public function checkAccess($action, $model = null, $params = [])
+    {
+        //TODO implement checkAccess
+    }
+
+    public function actionCreateInvoice($invoice)
+    {
+        //TODO implement actionCreateInvoice
+    }
+
+
+}
+

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/base/AbcController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace app\controllers\base;
+
+abstract class AbcController extends \yii\rest\Controller
+{
+    public function actions()
+    {
+        return [
+            'options' => [
+                'class' => \yii\rest\OptionsAction::class,
+            ],
+        ];
+    }
+
+    /**
+     * Checks the privilege of the current user.
+     *
+     * This method checks whether the current user has the privilege
+     * to run the specified action against the specified data model.
+     * If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
+     *
+     * @param string $action the ID of the action to be executed
+     * @param object $model the model to be accessed. If null, it means no specific model is being accessed.
+     * @param array $params additional parameters
+     * @throws \yii\web\ForbiddenHttpException if the user does not have access
+     */
+    abstract public function checkAccess($action, $model = null, $params = []);
+
+    abstract public function actionXyz();
+
+    abstract public function actionCreateXyz();
+
+}

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/base/PaymentController.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace app\controllers\base;
+
+abstract class PaymentController extends \yii\rest\Controller
+{
+    public function actions()
+    {
+        return [
+            'options' => [
+                'class' => \yii\rest\OptionsAction::class,
+            ],
+        ];
+    }
+
+    /**
+     * Checks the privilege of the current user.
+     *
+     * This method checks whether the current user has the privilege
+     * to run the specified action against the specified data model.
+     * If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
+     *
+     * @param string $action the ID of the action to be executed
+     * @param object $model the model to be accessed. If null, it means no specific model is being accessed.
+     * @param array $params additional parameters
+     * @throws \yii\web\ForbiddenHttpException if the user does not have access
+     */
+    abstract public function checkAccess($action, $model = null, $params = []);
+
+    abstract public function actionInvoicePayment();
+
+}

tests/specs/issue_fix/144_methods_naming_for_non_crud_actions/app/controllers/base/PaymentsController.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace app\controllers\base;
+
+abstract class PaymentsController extends \yii\rest\Controller
+{
+    public function actions()
+    {
+        return [
+            'options' => [
+                'class' => \yii\rest\OptionsAction::class,
+            ],
+        ];
+    }
+
+    /**
+     * Checks the privilege of the current user.
+     *
+     * This method checks whether the current user has the privilege
+     * to run the specified action against the specified data model.
+     * If the user does not have access, a [[ForbiddenHttpException]] should be thrown.
+     *
+     * @param string $action the ID of the action to be executed
+     * @param object $model the model to be accessed. If null, it means no specific model is being accessed.
+     * @param array $params additional parameters
+     * @throws \yii\web\ForbiddenHttpException if the user does not have access
+     */
+    abstract public function checkAccess($action, $model = null, $params = []);
+
+    abstract public function actionCreateInvoice($invoice);
+
+}