网页图片无法保存,seo官网优化怎么做,禅城专业网站建设公司,廊坊做网站优化yii2写api接口步骤Yii2如何实现RESTful风格的API(推荐#xff1a;《YII教程》 )1、建立单独的应用程序为了增加程序的可维护性#xff0c;易操作性#xff0c;我们选择新建一套应用程序#xff0c;这也是为了和前台应用、后台应用区分开操作。在WEB前端(frontend)和后端(ba…yii2写api接口步骤Yii2如何实现RESTful风格的API(推荐《YII教程》 )1、建立单独的应用程序为了增加程序的可维护性易操作性我们选择新建一套应用程序这也是为了和前台应用、后台应用区分开操作。在WEB前端(frontend)和后端(backend)的同级目录新建一个文件夹命名api,其目录结构如下所示├─assets│ AppAsset.php├─config│ bootstrap.php│ main-local.php│ main.php│ params-local.php│ params.php├─runtime└─web│ index.php├─assets└─css可以看出其目录结构基本上同backend没有其他差异因为我们就是拷贝backend项目只是做了部分优化。友情提醒该步骤完成以后需要修改common\config\bootstrap.php文件对新建的应用增加alias别名Yii::setAlias(api, dirname(dirname(__DIR__)) . /api);2、为新建的api应用程序美化路由首先保证你的web服务器开启rewrite规则细节我们就不说了不过这是前提。接着配置api/config/main.php文件components [// other configurlManager [enablePrettyUrl true,showScriptName false,enableStrictParsing true,rules [],]],开启nginx的rewrite注意在你的配置文件中加入红色的文字server {charset utf-8;client_max_body_size 128M;listen 80; ## listen for ipv4#listen [::]:80 default_server ipv6onlyon; ## listen for ipv6server_name mysite.local;root /path/to/basic/web;index index.php;access_log /path/to/basic/log/access.log;error_log /path/to/basic/log/error.log;location / {# Redirect everything that isnt a real file to index.phptry_files $uri $uri/ /index.php$is_args$args;}# uncomment to avoid processing of calls to non-existing static files by Yii#location ~ \.(js|css|png|jpg|gif|swf|ico|pdf|mov|fla|zip|rar)$ {# try_files $uri 404;#}#error_page 404 /404.html;# deny accessing php files for the /assets directorylocation ~ ^/assets/.*\.php$ {deny all;}location ~ \.php$ {include fastcgi_params;fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;fastcgi_pass 127.0.0.1:9000;#fastcgi_pass unix:/var/run/php5-fpm.sock;try_files $uri 404;}location ~* /\. {deny all;}}最后只需要在应用入口同级增加.htaccess文件就好我们以nginx为例# use mod_rewrite for pretty URL supportRewriteEngine on# if a directory or a file exists, use the request directlyRewriteCond %{REQUEST_FILENAME} !-fRewriteCond %{REQUEST_FILENAME} !-d# otherwise forward the request to index.phpRewriteRule . index.php3、利用gii生成测试modules用了便于演示说明我们新建一张数据表goods表并向其中插入几条数据。CREATE TABLE goods (id int(11) NOT NULL AUTO_INCREMENT,name varchar(100) NOT NULL DEFAULT ,PRIMARY KEY (id)) ENGINEInnoDB DEFAULT CHARSETutf8;INSERT INTO goods VALUES (1, 11111);INSERT INTO goods VALUES (2, 22222);INSERT INTO goods VALUES (3, 333);INSERT INTO goods VALUES (4, 444);INSERT INTO goods VALUES (5, 555);接着我们先利用gii生成modules后再利用gii模块按照下图中生成goods信息现在我们的api目录结构应该多个下面这几个目录│├─models│ Goods.php│├─modules│ └─v1│ │ Module.php│ ││ ├─controllers│ │ DefaultController.php│ │ GoodsController.php│ ││ └─views│ └─default│ index.php需要说明的是在生成modules的步骤中为了使我们的模块可以访问不要忘记在main.php配置文件中添加下面的代码?php ......modules [v1 [class api\modules\v1\Module,],],......4、重新配置控制器为了实现restful风格的api,在yii2中我们需要对控制器进行一下改写?php namespace api\modules\v1\controllers;use yii\rest\ActiveController;class GoodsController extends ActiveController{public $modelClass api\models\Goods;}5、为Goods配置Url规则rules [[class yii\rest\UrlRule,controller [v1/goods]],]6、模拟请求操作经过上面几个步骤到此我们已经为goods成功创建了满足restful风格的api了。为了更好更方便的演示我们借助工具postman进行模拟请求。为了见证一下我们的操作我们用postman请求一下GET /v1/goods看看结果如何接着我们先利用gii生成modules后再利用gii模块按照下图中生成goods信息现在我们的api目录结构应该多个下面这几个目录从上面截图中可以清楚的看到GET /v1/goods 已经能够很方便的获取我们表中的数据了。当然yii2还对该api封装了如下操作GET /users: 逐页列出所有用户HEAD /users: 显示用户列表的概要信息POST /users: 创建一个新用户GET /users/123: 返回用户 123 的详细信息HEAD /users/123: 显示用户 123 的概述信息PATCH /users/123 and PUT /users/123: 更新用户123DELETE /users/123: 删除用户123OPTIONS /users: 显示关于末端 /users 支持的动词OPTIONS /users/123: 显示有关末端 /users/123 支持的动词不信的话我们可以利用postman发送一个post请求到/v1/goods,我们会发现成功创建了一个新的商品。需要提醒的是操作中还请细心且注意如果你的控制器末端不是复数(比如是blog非blogs)请保证请求的时候是复数这是因为在RESTful架构中网址中只能有名词而不能包含动词名词又往往与数据表相对应数据表呢又是一个“集合”因此该名词往往是复数的形式。7、关于授权认证为什么需要授权认证这在一般的操作中是需要的。比如说用户要设置自己的信息。为了对yii2 restful授权认证说的更清楚我们将会以两个两种不同的方法进行说明。首先需要开启认证假设我们已经按照第3步创建了包含字段access-token的数据表user而且利用gii上生成了相应的model和controller配置main.php文件components [user [identityClass common\models\User,enableAutoLogin true,enableSessionfalse],],为控制器配置authenticator行为指定认证方式?php namespace api\modules\v1\controllers;use yii\rest\ActiveController;use yii\helpers\ArrayHelper;use yii\filters\auth\QueryParamAuth;class UserController extends ActiveController{public $modelClass api\models\User;public function behaviors() {return ArrayHelper::merge (parent::behaviors(), [authenticator [class QueryParamAuth::className()]] );}}最后我们还需要在identityClass中实现findIdentityByAccessToken方法public static function findIdentityByAccessToken($token, $type null){return static::findOne([access_token $token, status self::STATUS_ACTIVE]);}如此一来我们先通过postman模拟不带access-token请求看结果{name: Unauthorized,message: You are requesting with an invalid credential.,code: 0,status: 401,type: yii\\web\\UnauthorizedHttpException}提示401 我们没有权限访问我们在请求的链接上携带正确的access-token认证通过后控制器会再继续执行其他检查(频率限制、操作权限等)才可以返回正确的用户信息。需要提醒的是通过url的形式对access-token传递存在一定的风险有可能会造成数据的泄漏一般而言access-token需要放到HTTP头中进行传递除非客户端的请求是jsonp格式的关于授权认证我们有一篇更详细的文章包括一套完整案例、服务端返回的数据类型定义、自定义错误机制等。8、速率限制速率限制该操作完全也是出于安全考虑我们需要限制同一接口某时间段过多的请求。速率限制默认不启用用启用速率限制yii\web\User::identityClass 应该实现yii\filters\RateLimitInterface也就是说我们的common\models\User.php需要实现yii\filters\RateLimitInterface接口的三个方法具体代码可参考use yii\filters\RateLimitInterface;use yii\web\IdentityInterface;class User extends ActiveRecord implements IdentityInterface, RateLimitInterface{// other code ......// 返回某一时间允许请求的最大数量比如设置10秒内最多5次请求(小数量方便我们模拟测试)public function getRateLimit($request, $action){return [5, 10];}// 回剩余的允许的请求和相应的UNIX时间戳数 当最后一次速率限制检查时public function loadAllowance($request, $action){return [$this-allowance, $this-allowance_updated_at];}// 保存允许剩余的请求数和当前的UNIX时间戳public function saveAllowance($request, $action, $allowance, $timestamp){$this-allowance $allowance;$this-allowance_updated_at $timestamp;$this-save();}}需要注意的是你仍然需要在数据表User中新增加两个字段allowance剩余的允许的请求数量allowance_updated_at相应的UNIX时间戳数在我们启用了速率限制后Yii 会自动使用 yii\filters\RateLimiter 为 yii\rest\Controller 配置一个行为过滤器来执行速率限制检查。现在我们通过postman请求v1/users再看看结果会发现在10秒内调用超过5次API接口我们会得到状态为429太多请求的异常信息。{name: Too Many Requests,message: Rate limit exceeded.,code: 0,status: 429,type: yii\\web\\TooManyRequestsHttpException}9、关于版本为了兼容历史版本而且考虑向后兼容性我们在一开始操作的时候就以URL的方式实现了版本话这里就不再进行阐述了。10、错误处理Yii的REST框架的HTTP状态代码可参考如下就好没啥好说的200: OK。一切正常。201: 响应 POST 请求时成功创建一个资源。Location header 包含的URL指向新创建的资源。204: 该请求被成功处理响应不包含正文内容 (类似 DELETE 请求)。304: 资源没有被修改。可以使用缓存的版本。400: 错误的请求。可能通过用户方面的多种原因引起的例如在请求体内有无效的JSON 数据无效的操作参数等等。401: 验证失败。403: 已经经过身份验证的用户不允许访问指定的 API 末端。404: 所请求的资源不存在。405: 不被允许的方法。 请检查 Allow header 允许的HTTP方法。415: 不支持的媒体类型。 所请求的内容类型或版本号是无效的。422: 数据验证失败 (例如响应一个 POST 请求)。 请检查响应体内详细的错误消息。429: 请求过多。 由于限速请求被拒绝。500: 内部服务器错误。 这可能是由于内部程序错误引起的。