{"id":23919,"date":"2024-11-21T12:20:24","date_gmt":"2024-11-21T04:20:24","guid":{"rendered":"https:\/\/fwq.ai\/blog\/23919\/"},"modified":"2024-11-21T12:20:24","modified_gmt":"2024-11-21T04:20:24","slug":"yii%e6%a1%86%e6%9e%b6%e4%b8%ad%e7%9a%84restful-api%e5%bc%80%e5%8f%91","status":"publish","type":"post","link":"https:\/\/fwq.ai\/blog\/23919\/","title":{"rendered":"Yii\u6846\u67b6\u4e2d\u7684RESTful API\u5f00\u53d1"},"content":{"rendered":"

yii\u662f\u4e00\u6b3e\u57fa\u4e8ephp\u7684\u9ad8\u6027\u80fdmvc\u6846\u67b6\uff0c\u5b83\u63d0\u4f9b\u4e86\u975e\u5e38\u4e30\u5bcc\u7684\u5de5\u5177\u548c\u529f\u80fd\uff0c\u652f\u6301\u5feb\u901f\u3001\u9ad8\u6548\u5730\u5f00\u53d1 web \u5e94\u7528\u7a0b\u5e8f\u3002\u5176\u4e2d\uff0cyii\u6846\u67b6\u7684restful api\u529f\u80fd\u5f97\u5230\u4e86\u8d8a\u6765\u8d8a\u591a\u5f00\u53d1\u8005\u7684\u5173\u6ce8\u548c\u559c\u7231\uff0c\u56e0\u4e3a\u4f7f\u7528yii\u6846\u67b6\u53ef\u4ee5\u975e\u5e38\u65b9\u4fbf\u5730\u6784\u5efa\u51fa\u9ad8\u6027\u80fd\u3001\u6613\u6269\u5c55\u7684restful\u63a5\u53e3\uff0c\u4e3aweb\u5e94\u7528\u7684\u5f00\u53d1\u63d0\u4f9b\u4e86\u5f3a\u6709\u529b\u7684\u652f\u6301\u3002<\/p>\n

    \n
  1. RESTful API\u7b80\u4ecb<\/li>\n<\/ol>\n

    RESTful API\u662f\u4e00\u79cd\u57fa\u4e8eHTTP\u534f\u8bae\u7684API\u8bbe\u8ba1\u98ce\u683c\uff0c\u5176\u76ee\u7684\u662f\u521b\u5efa\u53ef\u4f38\u7f29\u548c\u6613\u4e8e\u7ef4\u62a4\u7684Web\u670d\u52a1\u3002\u8fd9\u79cdAPI\u98ce\u683c\u7531\u4e00\u7ec4\u72ec\u7acb\u7684\u8bf7\u6c42\u548c\u54cd\u5e94\u7ec4\u6210\uff0c\u5176\u4e2d\u8bf7\u6c42\u7531HTTP\u65b9\u6cd5\u3001URI\u548c\u6d88\u606f\u4f53\u7ec4\u6210\uff0c\u54cd\u5e94\u7531HTTP\u72b6\u6001\u7801\u548c\u6d88\u606f\u4f53\u7ec4\u6210\u3002REST\u662f\u4e00\u79cd\u65e0\u72b6\u6001\u7684\u67b6\u6784\u98ce\u683c\uff0c\u6bcf\u4e2a\u8bf7\u6c42\u90fd\u5305\u542b\u8db3\u591f\u7684\u4fe1\u606f\u4ee5\u4fbf\u670d\u52a1\u5668\u53ef\u4ee5\u81ea\u884c\u7406\u89e3\u3002<\/p>\n

      \n
    1. Yii\u6846\u67b6\u4e2d\u7684RESTful API<\/li>\n<\/ol>\n

      Yii\u6846\u67b6\u63d0\u4f9b\u4e86RESTful API\u7684\u652f\u6301\uff0c\u5b83\u4f7f\u5f97\u5f00\u53d1\u8005\u53ef\u4ee5\u5feb\u901f\u5730\u5f00\u53d1\u5f3a\u5927\u7684Web API\u3002Yii\u6846\u67b6\u4e2d\u5b9e\u73b0RESTful API\u7684\u65b9\u5f0f\u4e00\u822c\u6709\u4e24\u79cd\uff1aActiveController\u548cUrlRule\u3002<\/p>\n

      a. ActiveController<\/p>\n

      ActiveController\u662f\u57fa\u4e8e\u63a7\u5236\u5668\u7c7b\u7684\u4e00\u79cd\u5b9e\u73b0\u65b9\u5f0f\uff0c\u5b83\u63d0\u4f9b\u4e86\u4e00\u7ec4\u9ed8\u8ba4\u7684CRUD\u64cd\u4f5c\uff0c\u6bd4\u5982\u83b7\u53d6\u8d44\u6e90\u96c6\u5408\uff0c\u83b7\u53d6\u5355\u4e2a\u8d44\u6e90\uff0c\u521b\u5efa\u8d44\u6e90\uff0c\u66f4\u65b0\u8d44\u6e90\u548c\u5220\u9664\u8d44\u6e90\u3002\u5f00\u53d1\u8005\u53ea\u9700\u8981\u7ee7\u627fActiveController\u7c7b\u5e76\u91cd\u8f7d\u76f8\u5e94\u7684\u65b9\u6cd5\uff0c\u5c31\u53ef\u4ee5\u5b9e\u73b0\u81ea\u5df1\u7684API\u63a5\u53e3\u3002\u4e0b\u9762\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u4f8b\u5b50\uff1a<\/p>\n

      class PostController extends ActiveController\n{\n    public $modelClass = 'appmodelsPost';\n}<\/pre>\n
        \u767b\u5f55\u540e\u590d\u5236   <\/p>\n
      \u8fd9\u91cc\u6211\u4eec\u7ee7\u627f\u4e86ActiveController\u7c7b\uff0c\u5e76\u8bbe\u7f6e\u4e86$modelClass\u5c5e\u6027\u4e3a’appmodelsPost’\u3002\u8fd9\u6837\u5c31\u4f1a\u81ea\u52a8\u6839\u636ePost\u6a21\u578b\u7684\u5b9a\u4e49\u521b\u5efa\u76f8\u5e94\u7684CRUD\u63a5\u53e3\u3002\u4f8b\u5982\uff0c\u8bf7\u6c42GET \/posts\u5c06\u4f1a\u8fd4\u56de\u6240\u6709\u7684\u6587\u7ae0\u6570\u636e\uff0c\u8bf7\u6c42POST \/posts\u5c06\u4f1a\u521b\u5efa\u4e00\u7bc7\u65b0\u6587\u7ae0\u3002<\/p>\n
      b. UrlRule<\/p>\n
      UrlRule\u662fYii\u6846\u67b6\u4e2d\u7684\u4e00\u79cd\u8def\u7531\u89c4\u5219\uff0c\u901a\u8fc7\u5b83\u53ef\u4ee5\u5c06HTTP\u8bf7\u6c42\u6620\u5c04\u5230\u76f8\u5e94\u7684Controller\u548cAction\u3002\u4f7f\u7528UrlRule\u5b9e\u73b0RESTful API\u7684\u65b9\u5f0f\u76f8\u5bf9\u7075\u6d3b\uff0c\u6211\u4eec\u53ef\u4ee5\u6839\u636e\u81ea\u5df1\u7684\u9700\u6c42\u5b9a\u4e49\u4e0d\u540c\u7684\u8def\u7531\u89c4\u5219\uff0c\u4f8b\u5982\uff0c\u53ef\u4ee5\u4f7f\u7528\u4e0b\u9762\u7684\u4ee3\u7801\u5b9a\u4e49\u4e00\u4e2a\/posts\u63a5\u53e3\uff1a<\/p>\n
      'urlManager' =&gt; [\n    'enablePrettyUrl' =&gt; true,\n    'enableStrictParsing' =&gt; true,\n    'showScriptName' =&gt; false,\n    'rules' =&gt; [\n        ['class' =&gt; 'yiiestUrlRule', 'controller' =&gt; 'post'],\n    ],\n],<\/pre>\n
        \u767b\u5f55\u540e\u590d\u5236   <\/p>\n
      \u901a\u8fc7\u8fd9\u4e2a\u914d\u7f6e\uff0c\u6211\u4eec\u53ef\u4ee5\u8bbf\u95ee\/posts\u63a5\u53e3\u6765\u83b7\u53d6\u6240\u6709\u6587\u7ae0\u7684\u6570\u636e\u3002<\/p>\n
        \n
      1. RESTful API\u5b89\u5168\u6027<\/li>\n<\/ol>\n
        \u5728\u5f00\u53d1RESTful API\u65f6\uff0c\u5b89\u5168\u662f\u4e00\u4e2a\u975e\u5e38\u91cd\u8981\u7684\u95ee\u9898\u3002Yii\u6846\u67b6\u63d0\u4f9b\u4e86\u591a\u79cd\u5b89\u5168\u673a\u5236\u6765\u4fdd\u62a4API\u63a5\u53e3\u7684\u5b89\u5168\u6027\uff0c\u5176\u4e2d\u6700\u5e38\u7528\u7684\u6709Access Control\u548cBearer Token\u3002<\/p>\n
        a. Access Control<\/p>\n
        Access Control\u901a\u8fc7\u6388\u6743\u89c4\u5219\u6765\u7ba1\u7406\u7528\u6237\u5bf9API\u7684\u8bbf\u95ee\u6743\u9650\u3002Yii\u6846\u67b6\u63d0\u4f9b\u4e86\u4e00\u7ec4\u5f3a\u5927\u7684\u6743\u9650\u63a7\u5236\u7c7b\uff0c\u53ef\u4ee5\u65b9\u4fbf\u5730\u5b9e\u73b0RBAC(Role-Based Access Control)\u6743\u9650\u7ba1\u7406\u6a21\u5f0f\u3002\u4f8b\u5982\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u4e0b\u9762\u7684\u4ee3\u7801\u5728\u63a7\u5236\u5668\u4e2d\u5b9a\u4e49\u4e00\u4e2a\u8bbf\u95ee\u63a7\u5236\uff1a<\/p>\n
        public function behaviors()\n{\n    $behaviors = parent::behaviors();\n    $behaviors['access'] = [\n        'class' =&gt; AccessControl::className(),\n        'rules' =&gt; [\n            [\n                'actions' =&gt; ['create', 'update'],\n                'allow' =&gt; true,\n                'roles' =&gt; ['@'],\n            ],\n            [\n                'actions' =&gt; ['view', 'index'],\n                'allow' =&gt; true,\n                'roles' =&gt; ['?', '@'],\n            ],\n        ],\n    ];\n    return $behaviors;\n}<\/pre>\n
          \u767b\u5f55\u540e\u590d\u5236   <\/p>\n
        \u8fd9\u91cc\u6211\u4eec\u5b9a\u4e49\u4e86\u4e24\u4e2a\u89c4\u5219\uff0c\u5206\u522b\u5bf9\u5e94\u4e0d\u540c\u7684\u64cd\u4f5c\u548c\u7528\u6237\u6743\u9650\u3002\u4f8b\u5982\uff0ccreate\u548cupdate\u65b9\u6cd5\u9700\u8981\u7528\u6237\u767b\u5f55\u540e\u624d\u80fd\u8bbf\u95ee\uff0cview\u548cindex\u65b9\u6cd5\u5219\u53ef\u4ee5\u88ab\u533f\u540d\u7528\u6237\u548c\u5df2\u767b\u5f55\u7528\u6237\u8bbf\u95ee\u3002<\/p>\n
        b. Bearer Token<\/p>\n
        Bearer Token\u662f\u4e00\u79cd\u57fa\u4e8eOAuth2\u7684\u8eab\u4efd\u8ba4\u8bc1\u65b9\u5f0f\uff0c\u5b83\u53ef\u4ee5\u5728API\u8bf7\u6c42\u4e2d\u643a\u5e26access_token\u4f5c\u4e3a\u8eab\u4efd\u51ed\u8bc1\u3002Yii\u6846\u67b6\u63d0\u4f9b\u4e86BasiAuth\u548cOAuth2\u4e24\u79cd\u65b9\u5f0f\uff0c\u53ef\u4ee5\u8f7b\u677e\u5730\u5b9e\u73b0Bearer Token\u8eab\u4efd\u8ba4\u8bc1\u3002\u4f8b\u5982\uff0c\u6211\u4eec\u53ef\u4ee5\u4f7f\u7528\u4e0b\u9762\u7684\u4ee3\u7801\u5728\u5e94\u7528\u7a0b\u5e8f\u4e2d\u542f\u7528OAuth2\u8ba4\u8bc1\uff1a<\/p>\n
        'authManager' =&gt; [\n    'class' =&gt; 'yiiiltersuthQueryParamAuth',\n    'tokenParam' =&gt; 'accessToken',\n],<\/pre>\n
          \u767b\u5f55\u540e\u590d\u5236   <\/p>\n
        \u7136\u540e\u6211\u4eec\u53ef\u4ee5\u5728API\u8c03\u7528\u65f6\u5728URL\u4e2d\u643a\u5e26access_token\u4f5c\u4e3a\u51ed\u8bc1\uff0c\u6bd4\u5982\uff1a<\/p>\n
        GET \/posts?accessToken=ABCDEF123456<\/pre>\n
          \u767b\u5f55\u540e\u590d\u5236   <\/p>\n
          \n
        1. \u603b\u7ed3<\/li>\n<\/ol>\n
          Yii\u6846\u67b6\u662f\u4e00\u6b3e\u975e\u5e38\u5f3a\u5927\u7684MVC\u6846\u67b6\uff0c\u53ef\u4ee5\u975e\u5e38\u65b9\u4fbf\u5730\u5f00\u53d1\u9ad8\u6027\u80fd\u3001\u6613\u6269\u5c55\u7684RESTful API\u3002\u5728RESTful API\u7684\u5f00\u53d1\u4e2d\uff0c\u5b89\u5168\u6027\u662f\u4e00\u4e2a\u975e\u5e38\u91cd\u8981\u7684\u95ee\u9898\uff0cYii\u6846\u67b6\u63d0\u4f9b\u4e86\u591a\u79cd\u5b89\u5168\u673a\u5236\u6765\u4fdd\u62a4API\u63a5\u53e3\u7684\u5b89\u5168\u6027\u3002\u4f8b\u5982\uff0cAccess Control\u548cBearer Token\u53ef\u4ee5\u5206\u522b\u7528\u4e8e\u6388\u6743\u548c\u8eab\u4efd\u8ba4\u8bc1\uff0c\u4f18\u5316\u4e86RESTful API\u7684\u5b89\u5168\u6027\u3002\u56e0\u6b64\uff0c\u5728\u4f7f\u7528Yii\u6846\u67b6\u5f00\u53d1RESTful API\u65f6\uff0c\u4e00\u5b9a\u8981\u91cd\u89c6\u5b89\u5168\u6027\uff0c\u5efa\u7acb\u53ef\u9760\u7684API\u5b89\u5168\u673a\u5236\u3002<\/p>\n
          \u4ee5\u4e0a\u5c31\u662fYii\u6846\u67b6\u4e2d\u7684RESTful API\u5f00\u53d1\u7684\u8be6\u7ec6\u5185\u5bb9\uff0c\u66f4\u591a\u8bf7\u5173\u6ce8\u7c73\u4e91\u5176\u5b83\u76f8\u5173\u6587\u7ae0\uff01<\/p>\n","protected":false},"excerpt":{"rendered":"
          yii\u662f\u4e00\u6b3e\u57fa\u4e8ephp\u7684\u9ad8\u6027\u80fdmvc\u6846\u67b6\uff0c\u5b83\u63d0\u4f9b\u4e86\u975e\u5e38\u4e30\u5bcc\u7684\u5de5\u5177\u548c\u529f\u80fd\uff0c\u652f\u6301\u5feb\u901f\u3001\u9ad8\u6548\u5730\u5f00\u53d1 web \u5e94\u7528\u7a0b\u5e8f\u3002\u5176\u4e2d\uff0cyii\u6846\u67b6\u7684restful api\u529f\u80fd\u5f97\u5230\u4e86\u8d8a\u6765\u8d8a\u591a\u5f00\u53d1\u8005\u7684\u5173\u6ce8\u548c\u559c\u7231\uff0c\u56e0\u4e3a\u4f7f\u7528yii\u6846\u67b6\u53ef\u4ee5\u975e\u5e38\u65b9\u4fbf\u5730\u6784\u5efa\u51fa\u9ad8\u6027\u80fd\u3001\u6613\u6269\u5c55\u7684restful\u63a5\u53e3\uff0c\u4e3aweb\u5e94\u7528\u7684\u5f00\u53d1\u63d0\u4f9b\u4e86\u5f3a\u6709\u529b\u7684\u652f\u6301\u3002 RESTful API\u7b80\u4ecb RESTful API\u662f\u4e00\u79cd\u57fa\u4e8eHTTP\u534f\u8bae\u7684API\u8bbe\u8ba1\u98ce\u683c\uff0c\u5176\u76ee\u7684\u662f\u521b\u5efa\u53ef\u4f38\u7f29\u548c\u6613\u4e8e\u7ef4\u62a4\u7684Web\u670d\u52a1\u3002\u8fd9\u79cdAPI\u98ce\u683c\u7531\u4e00\u7ec4\u72ec\u7acb\u7684\u8bf7\u6c42\u548c\u54cd\u5e94\u7ec4\u6210\uff0c\u5176\u4e2d\u8bf7\u6c42\u7531HTTP\u65b9\u6cd5\u3001URI\u548c\u6d88\u606f\u4f53\u7ec4\u6210\uff0c\u54cd\u5e94\u7531HTTP\u72b6\u6001\u7801\u548c\u6d88\u606f\u4f53\u7ec4\u6210\u3002REST\u662f\u4e00\u79cd\u65e0\u72b6\u6001\u7684\u67b6\u6784\u98ce\u683c\uff0c\u6bcf\u4e2a\u8bf7\u6c42\u90fd\u5305\u542b\u8db3\u591f\u7684\u4fe1\u606f\u4ee5\u4fbf\u670d\u52a1\u5668\u53ef\u4ee5\u81ea\u884c\u7406\u89e3\u3002 Yii\u6846\u67b6\u4e2d\u7684RESTful API Yii\u6846\u67b6\u63d0\u4f9b\u4e86RESTful API\u7684\u652f\u6301\uff0c\u5b83\u4f7f\u5f97\u5f00\u53d1\u8005\u53ef\u4ee5\u5feb\u901f\u5730\u5f00\u53d1\u5f3a\u5927\u7684Web API\u3002Yii\u6846\u67b6\u4e2d\u5b9e\u73b0RESTful API\u7684\u65b9\u5f0f\u4e00\u822c\u6709\u4e24\u79cd\uff1aActiveController\u548cUrlRule\u3002 a. ActiveController ActiveController\u662f\u57fa\u4e8e\u63a7\u5236\u5668\u7c7b\u7684\u4e00\u79cd\u5b9e\u73b0\u65b9\u5f0f\uff0c\u5b83\u63d0\u4f9b\u4e86\u4e00\u7ec4\u9ed8\u8ba4\u7684CRUD\u64cd\u4f5c\uff0c\u6bd4\u5982\u83b7\u53d6\u8d44\u6e90\u96c6\u5408\uff0c\u83b7\u53d6\u5355\u4e2a\u8d44\u6e90\uff0c\u521b\u5efa\u8d44\u6e90\uff0c\u66f4\u65b0\u8d44\u6e90\u548c\u5220\u9664\u8d44\u6e90\u3002\u5f00\u53d1\u8005\u53ea\u9700\u8981\u7ee7\u627fActiveController\u7c7b\u5e76\u91cd\u8f7d\u76f8\u5e94\u7684\u65b9\u6cd5\uff0c\u5c31\u53ef\u4ee5\u5b9e\u73b0\u81ea\u5df1\u7684API\u63a5\u53e3\u3002\u4e0b\u9762\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u4f8b\u5b50\uff1a class PostController extends ActiveController { public $modelClass = ‘appmodelsPost’; } \u767b\u5f55\u540e\u590d\u5236 \u8fd9\u91cc\u6211\u4eec\u7ee7\u627f\u4e86ActiveController\u7c7b\uff0c\u5e76\u8bbe\u7f6e\u4e86$modelClass\u5c5e\u6027\u4e3a’appmodelsPost’\u3002\u8fd9\u6837\u5c31\u4f1a\u81ea\u52a8\u6839\u636ePost\u6a21\u578b\u7684\u5b9a\u4e49\u521b\u5efa\u76f8\u5e94\u7684CRUD\u63a5\u53e3\u3002\u4f8b\u5982\uff0c\u8bf7\u6c42GET \/posts\u5c06\u4f1a\u8fd4\u56de\u6240\u6709\u7684\u6587\u7ae0\u6570\u636e\uff0c\u8bf7\u6c42POST \/posts\u5c06\u4f1a\u521b\u5efa\u4e00\u7bc7\u65b0\u6587\u7ae0\u3002 b. UrlRule UrlRule\u662fYii\u6846\u67b6\u4e2d\u7684\u4e00\u79cd\u8def\u7531\u89c4\u5219\uff0c\u901a\u8fc7\u5b83\u53ef\u4ee5\u5c06HTTP\u8bf7\u6c42\u6620\u5c04\u5230\u76f8\u5e94\u7684Controller\u548cAction\u3002\u4f7f\u7528UrlRule\u5b9e\u73b0RESTful API\u7684\u65b9\u5f0f\u76f8\u5bf9\u7075\u6d3b\uff0c\u6211\u4eec\u53ef\u4ee5\u6839\u636e\u81ea\u5df1\u7684\u9700\u6c42\u5b9a\u4e49\u4e0d\u540c\u7684\u8def\u7531\u89c4\u5219\uff0c\u4f8b\u5982\uff0c\u53ef\u4ee5\u4f7f\u7528\u4e0b\u9762\u7684\u4ee3\u7801\u5b9a\u4e49\u4e00\u4e2a\/posts\u63a5\u53e3\uff1a ‘urlManager’ =&gt; [ ‘enablePrettyUrl’ =&gt; true, ‘enableStrictParsing’ =&gt; true, ‘showScriptName’ =&gt; false, ‘rules’ =&gt; [ [‘class’ =&gt; ‘yiiestUrlRule’, ‘controller’ =&gt; […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[16],"tags":[],"class_list":["post-23919","post","type-post","status-publish","format-standard","hentry","category-16"],"_links":{"self":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23919","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/comments?post=23919"}],"version-history":[{"count":0,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/posts\/23919\/revisions"}],"wp:attachment":[{"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/media?parent=23919"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/categories?post=23919"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/fwq.ai\/blog\/wp-json\/wp\/v2\/tags?post=23919"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}