Yii2：定义“ID”以外的 REST API 参数

Question

我正在尝试利用 YII2 REST API（基于高级模板）来创建我自己的服务。我目前正在成功使用以下 URL 向我返回一条“文章”记录：

http://service/articles/view?id=1

我现在正在尝试复制此代码，以便它适用于另一种记录类型。我的新记录有一个名为“key”的主键，我想用它来搜索。因此，我需要将参数名称“id”更改为“key”。

有人能解释一下如何在此 URL 上指定除“id”之外的参数吗？每当我省略 id 作为参数时，我都会收到“错误请求：缺少必需参数：id”。我不明白这个必需参数来自哪里以及如何更改或添加它。

相关类如下所示：

class ArticleController extends ActiveController
{
    /**
     * @var string
     */
    public $modelClass = 'frontend\modules\api\v1\resources\Article';
    /**
     * @var array
     */
    public $serializer = [
        'class' => 'yii\rest\Serializer',
        'collectionEnvelope' => 'items'
    ];

    /**
     * @inheritdoc
     */
    public function actions()
    {
        return [
            'index' => [
                'class' => 'yii\rest\IndexAction',
                'modelClass' => $this->modelClass,
                'prepareDataProvider' => [$this, 'prepareDataProvider']
            ],
            'view' => [
                'class' => 'yii\rest\ViewAction',
                'modelClass' => $this->modelClass,
                'findModel' => [$this, 'findModel']
            ],
            'options' => [
                'class' => 'yii\rest\OptionsAction'
            ]
        ];
    }

    /**
     * @return ActiveDataProvider
     */
    public function prepareDataProvider()
    {
        return new ActiveDataProvider(array(
            'query' => Article::find()->published()
        ));
    }

    /**
     * @param $id
     * @return array|null|\yii\db\ActiveRecord
     * @throws HttpException
     */
    public function findModel($id)
    {
        $model = Article::find()
            ->published()
            ->andWhere(['id' => (int) $id])
            ->one();
        if (!$model) {
            throw new HttpException(404);
        }
        return $model;
    }
}

class Article extends \common\models\Article implements Linkable
{
    public function fields()
    {
        return ['id', 'slug', 'category_id', 'title', 'body', 'published_at'];
    }

    public function extraFields()
    {
        return ['category'];
    }

    /**
     * Returns a list of links.
     *
     * @return array the links
     */
    public function getLinks()
    {
        return [
            Link::REL_SELF => Url::to(['article/view', 'id' => $this->id], true)
        ];
    }
}

提前致谢。

编辑：“前端”文件夹结构中 urlManager 的规范如下：

<?php
return [
    'class'=>'yii\web\UrlManager',
    'enablePrettyUrl'=>true,
    'showScriptName'=>false,
    'rules'=> [
        // Pages
        ['pattern'=>'page/<slug>', 'route'=>'page/view'],

        // Articles
        ['pattern'=>'article/index', 'route'=>'article/index'],
        ['pattern'=>'article/attachment-download', 'route'=>'article/attachment-download'],
        ['pattern'=>'article/<slug>', 'route'=>'article/view'],

        // Api
        ['class' => 'yii\rest\UrlRule', 'controller' => 'api/v1/article', 'only' => ['index', 'view', 'options']],
        ['class' => 'yii\rest\UrlRule', 'controller' => 'api/v1/user', 'only' => ['index', 'view', 'options']]
    ]
];

Answer 1

这可以通过在配置文档中向您的 urlmanager 添加规则来完成，可以找到 here

例子：

'rules' => [
    [   'class' => 'yii\rest\UrlRule',
        'pluralize' => false,
        'controller' => [
            'yourController',
        ],
        'patterns' => [
            'PUT,PATCH {id}' => 'update',
            'DELETE {id}' => 'delete',
            'GET,HEAD {id}' => 'view',
            'GET,HEAD {key}' => 'view',
            'POST' => 'create',
            'GET,HEAD' => 'index',
            '{id}' => 'options',
            'OPTIONS' => 'options',
            'PUT,PATCH {key}' => 'update',
        ],
         'tokens' => [
            '{id}' => '<id:\\d[\\d,]*>',
            '{type}' => '<type:\\w[\\w,]*>',
            '{key}' => '<key:\\w[\\w,]*>',
        ],
    ],
]

将动作映射添加到您的控制器

class YourController extends ActiveController {

    public $modelClass = 'your\model\Class';

    public function actions() {
        return array_merge(parent::actions(), [
            'view' => [
                'class' => \rest\your\ViewAction',
                'modelClass' => $this->modelClass,
            ],
        ]);
    }
}

并将关键参数添加到您的操作中

class ViewAction  extends \yii\rest\ViewAction {

    public function run($id = null, $key = null)
    {
        // your code
    }
}

现在你应该可以做到了

GET your/{keyparam} -> wil resolve to yourController -> ViewAction

Answer 2

我不知道这是否是官方的做法，但我创建了一个额外的 Action 来处理这种情况。似乎“id”参数来自反映动作中的“run”方法调用，所以我可以使用称为“key”的不同参数的唯一方法是完全像这样定义函数：

class ExtraAction extends Action  // in yii/rest
{
    public function run($key)  // NOTE: The name 'key' is reflected and then becomes an expected parameter
    {
        $model = $this->findModel($key);

        if (!$model) {
            throw new HttpException(404);
        }
        return $model;
    }
}

完成后，我需要像这样更改我的 actions() 定义：

    'view' => [
        'class' => 'yii\rest\ExtraAction',
        'modelClass' => $this->modelClass,
        'findModel' => [$this, 'findModel']
    ],

然后控制器中的findModel($id) 将接收在GET URL 中定义的'key' 参数（例如api/v1/article?key=blah123）。

然后我可以根据我拥有的不同唯一键执行查找：

public function findModel($id)
{
    $model = Record::find()
    ->andWhere(['key_field' => $id])
    ->one();    
} 

我不知道这是否是正确的做法，但它似乎确实适用于这种情况。

Answer 3

像往常一样在ArticleController 中创建新方法：

public function actionView2($your_desired_parameter) {
    $article = Article::find()->where(['your_desired_parameter'=>$your_desired_parameter]);
    if (!$article->exists()) 
        throw new NotFoundHttpException();
    return $article->one();
}