main.php 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. <?php
  2. $params = array_merge (
  3. require(__DIR__ . '/../../../common/config/params.php'),
  4. require(__DIR__ . '/../../../common/config/params-local.php'),
  5. require(__DIR__ . '/params.php'),
  6. require(__DIR__ . '/params-local.php')
  7. );
  8. return [
  9. 'id' => 'app-api',
  10. 'basePath' => dirname(__DIR__),
  11. 'bootstrap' => [
  12. 'log',
  13. //全局内容协商
  14. [
  15. //ContentNegotiator 类可以分析request的header然后指派所需的响应格式给客户端,不需要我们人工指定
  16. 'class' => 'yii\filters\ContentNegotiator',
  17. 'formats' => [
  18. 'application/json' => yii\web\Response::FORMAT_JSON,
  19. 'application/xml' => yii\web\Response::FORMAT_XML,
  20. //api 端目前只需要json 和 xml
  21. //还可以增加 yii\web\Response 类内置的响应格式,或者自己增加响应格式
  22. ],
  23. ]
  24. ],
  25. 'defaultRoute' => 'main/index',//默认控制器
  26. 'controllerNamespace' => 'api\controllers',
  27. //新增中 -- shizhongqi
  28. 'modules' => [
  29. /*'v1' => [
  30. 'class' => '\modules\v1\Module',
  31. ],*/
  32. ],
  33. //
  34. 'components' => [
  35. 'jwt' => [
  36. 'class' => 'api\components\Jwt',
  37. ],
  38. 'user' => [
  39. 'identityClass' => 'common\models\xhAdmin',
  40. 'enableAutoLogin' => true,
  41. 'identityCookie' => [
  42. 'name' => 'backendUser', // unique for backend
  43. ],
  44. 'loginUrl' => ['main/login'],
  45. ],
  46. 'log' => [
  47. 'traceLevel' => YII_DEBUG ? 3 : 0,
  48. 'targets' => [
  49. [
  50. 'class' => 'yii\log\FileTarget',
  51. 'levels' => ['error', 'warning'],
  52. ],
  53. ],
  54. ],
  55. //新增,不理解有什么用处,后期了解下 -- shizhonqi
  56. 'response' => [
  57. 'class' => 'yii\web\Response',
  58. //设置 api 返回格式,错误码不在 header 里实现,而是放到 body里
  59. 'as resBeforeSend' => [
  60. 'class' => 'api\components\ResBeforeSendBehavior',
  61. 'defaultCode' => 500,
  62. 'defaultMsg' => 'error',
  63. ],
  64. //ps:components 中绑定事件,可以用两种方法
  65. //'on eventName' => $eventHandler,
  66. //'as behaviorName' => $behaviorConfig,
  67. //参考 http://www.yiiframework.com/doc-2.0/guide-concept-configurations.html#configuration-format
  68. ],
  69. /*'errorHandler' => [
  70. 'errorAction' => 'site/error',
  71. ],*/
  72. //变动 -- shizhonqi
  73. //TODO 路由规则验证中
  74. 'urlManager' => [
  75. 'enablePrettyUrl' => true,
  76. // 注意:如果不需要严格解析路由请直接删除或注释此行代码
  77. // 'enableStrictParsing' => true,
  78. // 是否在URL中显示入口脚本。是对美化功能的进一步补充。
  79. 'showScriptName' => false,
  80. //路由不正确也能正常运行 -- ???
  81. 'rules' => [
  82. '<controller:\w+>/<action:\w+>'=>'<controller>/<action>',
  83. [
  84. 'class' => 'yii\rest\UrlRule',
  85. 'controller' => 'user',
  86. 'pluralize' => false, //设置为false 就可以去掉复数形式了*/
  87. 'extraPatterns'=>[
  88. 'GET test'=>'test'
  89. ],
  90. ],
  91. //"GET user/create" => "user/create",
  92. //当然,如果自带的路由无法满足需求,可以自己增加规则
  93. 'GET <module:(v)\d+>/<controller:\w+>/search' => '<module>/<controller>/search',
  94. [
  95. 'class' => 'yii\rest\UrlRule',
  96. 'controller' => ['v1/user'],
  97. // 由于 resetful 风格规定 URL 保持格式一致并且始终使用复数形式
  98. // 所以如果你的 controller 是单数的名称比如 UserController
  99. // 设置 pluralize 为 true (默认为 true)的话,url 地址必须是 users 才可访问
  100. // 如果 pluralize 设置为 false, url 地址必须是 user 也可访问
  101. // 如果你的 controller 本身是复数名称 UsersController ,此参数没用,url 地址必须是 users
  102. 'pluralize' => false,
  103. ],
  104. ],
  105. ],
  106. ],
  107. 'params' => $params,
  108. ]
  109. ;