php - Yii2 Rest - 自定义操作和 OPTIONS 方法

Question

我在我的 UsersController 类中遇到以下操作“/login”路由操作的问题

public function actionLogin(){
        $data = Yii::$app->getRequest()->getBodyParams();
        $model = new Usuario();

        //Validamos que se hayan recibido los campos
        if(empty($data['email']) || empty($data['password'])){
            throw new \yii\web\BadRequestHttpException("Debe ingresar email y password");
        }

        //Validamos usuario y contraseña
        $usuario = $model->findByUsername($data['email']);
        if(empty($usuario) || !$usuario->validatePassword($data['password'])){
            throw new \yii\web\UnauthorizedHttpException("Usuario y/o contraseña incorrectos");
        }
        return $usuario;
    }

情况是我正在使用 POST 方法执行登录，并且我从不同的域调用此路由，因此前端库首先尝试使用 OPTIONS 方法调用/login 路由以检查它是否被允许或不要用 POST 调用/login..

问题是 yii2 rest ActiveController 的内置功能仅适用于/users 和/users/{id}

如果我通过 actions verbFilter 手动添加此/login 路由以在 POST 和 OPTIONS 中可用，那么 yii 会尝试使用 OPTIONS 请求实际调用登录操作。我的意思是，它正在尝试执行登录。当然不能，因为它不发送电子邮件和密码字段，但我可以在日志文件中看到错误。

所以，我的问题是......有没有什么方法可以正确配置这个“自定义”路由操作并使 OPTIONS 透明执行？因为我希望在使用 OPTIONS 调用它时不会执行登录操作，而是直接返回 OPTIONS 允许的方法 header 。

更新信息:添加了 URL 管理器规则

'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => true,
        'rules' => [
            [
                'class' => 'yii\rest\UrlRule', 
                'controller' => ['v1/users'],
                'pluralize' => false,
                'tokens' => [
                    '{id}' => '<id:\\w+>'
                ]
            ],
            //Rutas usuario
            'v1/login' => '/v1/users/login'
        ],        
    ],

Answer 1

默认情况下，yii\rest\UrlRule 类会将这些模式应用于任何端点:

'patterns' => [
    'PUT,PATCH {id}' => 'update',
    'DELETE {id}' => 'delete',
    'GET,HEAD {id}' => 'view',
    'POST' => 'create',
    'GET,HEAD' => 'index',
    '{id}' => 'options',
    '' => 'options',
]

这意味着如果您的 loginAction 是在扩展 ActiveControlleryii\rest\OptionsAction >.

我的建议是通过保留唯一使用的动词来覆盖 patterns，因为您的 login 操作不需要任何其他 CRUD 操作。这应该适用于您的情况:

'rules' => [
    [
        'class' => 'yii\rest\UrlRule', 
        'controller' => ['v1/users'],
        'pluralize' => false,
        'tokens' => [
            '{id}' => '<id:\\w+>'
        ]
    ],
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => ['v1/login' => '/v1/users/login'],
        'patterns' => [
            'POST' => 'login',
            '' => 'options',
        ]
    ] 
],

注意:@CreatoR 的解决方案也是这里的要求，并且与他在没有定义键的情况下所做的完全一样。否则，如果未通过身份验证，OPTIONS 动词将被拒绝。

---

如果您的login 操作是在直接扩展yii\rest\Controller 而不是通过yii\rest\ActiveController 的类下定义的> (这应该适用于身份验证操作，因为这里不需要 CRUD)那么相同的 rules 配置应该可以正常工作，但您需要手动将 actionOptions 添加到你的代码:

// grabbed from yii\rest\OptionsAction with a little work around
private $_verbs = ['POST','OPTIONS'];

public function actionOptions ()
{
    if (Yii::$app->getRequest()->getMethod() !== 'OPTIONS') {
        Yii::$app->getResponse()->setStatusCode(405);
    }
    $options = $this->_verbs;
    Yii::$app->getResponse()->getHeaders()->set('Allow', implode(', ', $options));
}