Yii2路由使用带有几个参数的yii\rest\UrlRule

wz3gfoph  于 2022-11-09  发布在  其他
关注(0)|答案(4)|浏览(151)

我正在尝试使用Yii 2路由的REST API。
http://www.yiiframework.com/doc-2.0/guide-rest-routing.html的教程之后,我已经为API入口点定义了很多规则,如下所示:

'urlManager' => [
    'enablePrettyUrl' => true,
    'enableStrictParsing' => true,
    'showScriptName' => false,
    'rules' => [
        [
            'class' => 'yii\rest\UrlRule', 
            'controller' => 'user'
        ],
    ],
]

这样的规则定义:

  • GET /用户(列出用户)
  • GET /users/123(显示用户123详细信息)

现在,我的用户有游戏。所以我想有网址:

  • GET /用户/123/游戏(列出用户123的游戏)
  • GET /用户/123/游戏/864(用户123的游戏864的细节-诸如他的分数)

我试着这样定义我的新切入点(没有成功):

'rules' => [
    ... previous rules ...,
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => [
            'game'
        ],
        'tokens' => [
            '{userid}' => '<userid:\\d>',
            '{gameid}' => '<gameid:\\d>',
        ],
        'patterns' => [
            'GET,HEAD /users/{userid}/games' => 'index',
            'GET,HEAD /users/{userid}/games/{gameid}' => 'view',
        ]
    ]
]

这个定义似乎是错误的,因为我得到了一个404页面未找到错误。我应该如何定义我的新网址路由?我想使用一个等效的格式为我的定义,扩展'yii\rest\UrlRule'
我不确定这是否是可能的,教程没有提到这种情况。

jhkqcmku

jhkqcmku1#

所以我想出了如何使用更复杂的规则。
首先是解决方案,然后是解释。
解决方案如下:

'rules' => [
    ... previous rules ...,
    [
        'class' => 'yii\rest\UrlRule',
        'controller' => 'game',
        'prefix' => '/users/<userid:\\d+>',
        'tokens' => [
            '{gameid}' => '<gameid:\\d+>',
        ],
        'patterns' => [
            'GET,HEAD' => 'index',
            'GET,HEAD {gameid}' => 'view',
        ]
    ]
]

现在解释一下:

  • 首先,我的userid / gameid属性定义错误。在“\d”后面缺少“+”
  • 控制器似乎是作为前缀自动添加到模式中的。所以你必须同时定义一个控制器和一个前缀(将在控制器之前添加)。
  • 前缀中的参数似乎没有被解析以找到标记。所以我直接在前缀中写了regexp,而不是添加“userid”作为标记。
  • 最后,在连接“prefix/controller/pattern”时会自动添加各种“/”,因此您不必编写它们。
  • “游戏”是单数的,但有效的网址将是单数的。
  • /用户/游戏123/
  • /用户/123/游戏/789

希望能有所帮助。

0dxa2lsx

0dxa2lsx2#

我认为有一个简单的解决方案,请尝试这个:

'rules' => [
                ...
                '/users/<userId:\\d+>/games' => 'game/index' ,
                '/users/<userId:\\d+>/games/<gameId:\\d+>' => 'game/view' ,
                ....
];
piok6c0g

piok6c0g3#

只使用yii2-nested-rest
它为Yii2框架中的多对多关系提供REST API。
希望评论会使魔术更容易理解:

'rules' => [
// this usual rule for base Yii2 rest usage
['class' => 'yii\rest\UrlRule', 'controller' => ['sitecomponent' ,'sitepage' , 'sitedomain'], 'pluralize'=>false
],
// then rules for yii2-nested-rest
[
    // url    sitepage/NNN/sitecomponent[/MMM]
    //       ^^^^^^^^^      ^^^^^^^^^^^^
    //       resourceName   model-endpoint
    'class' => 'tunecino\nestedrest\UrlRule',
    'modelClass' => 'app\models\SitePage',
    'resourceName' => 'sitepage',
    'relations'   => ['components' =>          ['sitecomponent'=>'sitecomponent'] ],
    //              ^^^^^^^^^^^^^^^^             ^^^^^^^^^^^^^    ^^^^^^^^^^^
    //              relation name                url-endpoint    controller]
    //              defined in model SitePage    model-endpoint   with Actions from nested
    ],
    [
    // cross url    sitecomponent/NNN/sitepage[/MMM]
    'class' => 'tunecino\nestedrest\UrlRule',
    'modelClass' => 'app\models\SiteComponent',
    'resourceName' => 'sitecomponent',
    'relations' => ['pages'        =>          ['sitepage'  =>  'sitepage'] ],
    //              ^^^^^^^^^^^^^^^^            ^^^^^^^^^^^^     ^^^^^^^^^
    //              relation name              url-endpoint     controller
    //              from model SiteComponent   model-endpoint   with Actions from nested
    ],

],

ghhkc1vu

ghhkc1vu4#

获取xx.com/v2/publication/12/p/34

[
                'class' => 'yii\rest\UrlRule',
                'pluralize' => false,//controller是否复数
                'controller' => 'v2/publication',//此处一定要加上v2
                'tokens' => [
                    '{id}' => '<id:\\d[\\d,]*>',
                    '{phase}' => '<phase:\\d[\\d,]*>',
                ],
                // 通过extraPatterns和tokens来实现多个参数传递
                'extraPatterns' => [
                    'GET,HEAD {id}/p/{phase}' => 'phase',
                ],
            ],

行动中

public function actionPhase($id, $phase){}

相关问题