Yii2 Restful api设计--App接口编程

最新推荐文章于 2021-03-24 00:16:01 发布
最新推荐文章于 2021-03-24 00:16:01 发布
阅读量226 收藏
点赞数
文章标签： php json 运维
原文链接：http://www.cnblogs.com/xiong63/p/8548039.html
版权

Yii2框架写一套RESTful风格的API，对照魏曦教你学

一，入门

一、目录结构

实现一个简单地RESTful API只需用到三个文件。目录如下：

复制代码 
frontend
    ├─ config
    │   └ main.php
    ├─ controllers
    │   └ BookController.php
    └─ models
        └ Book.php
复制代码

二、配置URL规则

1.修改服务器的rewrite规则，将所有URL全部指向index.php上，使其支持 /books/1 格式。
如果是Apache服务器，在frontend/web/ 目录中新建.htaccess文件。文件内容如下：

RewriteEngine on
# If a directory or a file exists, use the request directly
    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
# Otherwise forward the request to index.php
    RewriteRule . index.php

如果是Nginx服务器，修改nginx/conf/nginx.conf，在当前"server{}"的"location / {}"中添加下面红色标记内容：

location / {
　　try_files $uri $uri/ /index.php$is_args$args;
}

2.修改frontend/config/main.php文件，为book控制器增加一个 URL 规则。这样，就能通过美化的 URL 和有意义的 http 动词进行访问和操作数据。配置如下：

复制代码 
'components' => [
    'urlManager' => [
        'enablePrettyUrl' => true,
        'enableStrictParsing' => true,
        'showScriptName' => false,
        'rules' => [
            ['class' => 'yii\rest\UrlRule', 'controller' => 'book'],
        ],
    ],
],
复制代码

三、创建一个model

1.在数据库中创建一张book表。book表的内容如下：

复制代码 
-- ----------------------------
-- Table structure for book
-- ----------------------------
DROP TABLE IF EXISTS `book`;
CREATE TABLE `book` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` char(50) NOT NULL DEFAULT '',
  `num` tinyint(3) unsigned NOT NULL DEFAULT '0',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of book
-- ----------------------------
INSERT INTO `book` VALUES ('1', 'toefl', '10');
INSERT INTO `book` VALUES ('2', 'ielts', '20');
INSERT INTO `book` VALUES ('3', 'sat', '30');
INSERT INTO `book` VALUES ('4', 'gre', '40');
INSERT INTO `book` VALUES ('5', 'gmat', '50');
复制代码

2.在frontend/models/目录中新建Book.php。文件内容如下：

复制代码 
namespace frontend\models;

use yii\db\ActiveRecord;

class Book extends ActiveRecord
{
    public static function tableName()
    {
        return 'book';
    }
}
复制代码

四、创建一个控制器

在frontend/controllers/目录中新建BookController.php。控制器类扩展自 yii\rest\ActiveController。通过指定 yii\rest\ActiveController::modelClass 作为 frontend\models\Book， 控制器就能知道使用哪个模型去获取和处理数据。文件内容如下：

复制代码 
namespace frontend\controllers;

use yii\rest\ActiveController;

class BookController extends ActiveController
{
    public $modelClass = 'frontend\models\Book';
}
复制代码

五、测试

到这里，我们就已经完成了创建用于访问用户数据 的 RESTful 风格的 API。创建的 API 包括：

复制代码 
GET /books: 列出所有的书
HEAD /books: 显示书的列表的概要信息
POST /books: 新增1本书
GET /books/1: 返回 书ID=1的详细信息
HEAD /books/1: 显示 书ID=1的概述信息
PATCH /books/1 and PUT /books/1: 更新书ID=1的信息
DELETE /books/1: 删除书ID=1的信息
OPTIONS /books: 显示关于末端 /books 支持的动词
OPTIONS /books/1: 显示有关末端 /books/1 支持的动词
复制代码

可以通过Web浏览器中输入 URL http://{frontend的域名}/books 来访问API，或者使用一些浏览器插件来发送特定的 headers 请求，比如Firefox的RestClient、Chrome的Advanced Rest Client、postman等。

六、说明

1.Yii 将在末端使用的控制器的名称自动变为复数。这是因为 yii\rest\UrlRule 能够为他们使用的末端全自动复数化控制器。可以通过设置yii\rest\UrlRule::pluralize为false来禁用此行为:

'rules' => [
    ['class' => 'yii\rest\UrlRule', 'controller' => 'book', 'pluralize' => false],
],

2.可以使用fields和expand参数指定哪些字段应该包含在结果内。例如：URL http://{frontend的域名}/books?fields=name,num 将只返回 name 和 num 字段。

二，格式化响应，授权认证和速率限制

一、目录结构

先列出需要改动的文件。目录如下：

复制代码 
web
 ├─ common
 │      └─ models 
 │              └ User.php
 └─ frontend
        ├─ config
        │   └ main.php
        └─ controllers
            └ BookController.php
复制代码

二、格式化响应

Yii2 RESTful支持JSON和XML格式，如果想指定返回数据的格式，需要配置yii\filters\ContentNegotiator::formats属性。例如，要返回JSON格式，修改frontend/controllers/BookController.php，加入红色标记代码:

复制代码 
namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;

class BookController extends ActiveController
{
    public $modelClass = 'frontend\models\Book';

    public function behaviors() {
        $behaviors = parent::behaviors();
        $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
        return $behaviors;
    }
}
复制代码

返回XML格式：FORMAT_XML。formats属性的keys支持MIME类型，而values必须在yii\web\Response::formatters中支持被响应格式名称。

三、授权认证

RESTful APIs通常是无状态的，因此每个请求应附带某种授权凭证，即每个请求都发送一个access token来认证用户。

1.配置user应用组件（不是必要的，但是推荐配置）：
　　设置yii\web\User::enableSession属性为false（因为RESTful APIs为无状态的，当yii\web\User::enableSession为false，请求中的用户认证状态就不能通过session来保持）
　　设置yii\web\User::loginUrl属性为null（显示一个HTTP 403 错误而不是跳转到登录界面）
具体方法，修改frontend/config/main.php，加入红色标记代码：

复制代码 
'components' => [
    ...
    'user' => [
        'identityClass' => 'common\models\User',
        'enableAutoLogin' => true,
        
        'enableSession' => false,
        'loginUrl' => null,
        
    ],
    ...
]
复制代码

2.在控制器类中配置authenticator行为来指定使用哪种认证方式，修改frontend/controllers/BookController.php，加入红色标记代码：

复制代码 
namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;

use yii\filters\auth\CompositeAuth;
use yii\filters\auth\QueryParamAuth;

class BookController extends ActiveController
{
    public $modelClass = 'frontend\models\Book';

    public function behaviors() {
        $behaviors = parent::behaviors();
    
        $behaviors['authenticator'] = [
            'class' => CompositeAuth::className(),
            'authMethods' => [
                /*下面是三种验证access_token方式*/
                //1.HTTP 基本认证: access token 当作用户名发送，应用在access token可安全存在API使用端的场景，例如，API使用端是运行在一台服务器上的程序。
                //HttpBasicAuth::className(),
                //2.OAuth 2: 使用者从认证服务器上获取基于OAuth2协议的access token，然后通过 HTTP Bearer Tokens 发送到API 服务器。
                //HttpBearerAuth::className(),
                //3.请求参数: access token 当作API URL请求参数发送，这种方式应主要用于JSONP请求，因为它不能使用HTTP头来发送access token
                //http://localhost/user/index/index?access-token=123
                QueryParamAuth::className(),
            ],
        ];
        
        $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
        return $behaviors;
    }
}
复制代码

3.创建一张user表

复制代码 
-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `username` varchar(20) NOT NULL DEFAULT '' COMMENT '用户名',
  `password_hash` varchar(100) NOT NULL DEFAULT '' COMMENT '密码',
  `password_reset_token` varchar(50) NOT NULL DEFAULT '' COMMENT '密码token',
  `email` varchar(20) NOT NULL DEFAULT '' COMMENT '邮箱',
  `auth_key` varchar(50) NOT NULL DEFAULT '',
  `status` tinyint(3) unsigned NOT NULL DEFAULT '0' COMMENT '状态',
  `created_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '创建时间',
  `updated_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '更新时间',
  `access_token` varchar(50) NOT NULL DEFAULT '' COMMENT 'restful请求token',
  `allowance` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'restful剩余的允许的请求数',
  `allowance_updated_at` int(10) unsigned NOT NULL DEFAULT '0' COMMENT 'restful请求的UNIX时间戳数',
  PRIMARY KEY (`id`),
  UNIQUE KEY `username` (`username`),
  UNIQUE KEY `access_token` (`access_token`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', 'admin', '$2y$13$1KWwchqGvxDeORDt5pRW.OJarf06PjNYxe2vEGVs7e5amD3wnEX.i', '', '', 'z3sM2KZvXdk6mNXXrz25D3JoZlGXoJMC', '10', '1478686493', '1478686493', '123', '4', '1478686493');
复制代码

在common/models/User.php类中实现 yii\web\IdentityInterface::findIdentityByAccessToken()方法。修改common/models/User.php，加入红色标记代码：：

复制代码 
public static function findIdentityByAccessToken($token, $type = null)
{
    //findIdentityByAccessToken()方法的实现是系统定义的
    //例如，一个简单的场景，当每个用户只有一个access token, 可存储access token 到user表的access_token列中， 方法可在User类中简单实现，如下所示：
    return static::findOne(['access_token' => $token]);
    //throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
}
复制代码

四、速率限制

为防止滥用，可以增加速率限制。例如，限制每个用户的API的使用是在60秒内最多10次的API调用，如果一个用户同一个时间段内太多的请求被接收，将返回响应状态代码 429 (这意味着过多的请求)。

1.Yii会自动使用yii\filters\RateLimiter为yii\rest\Controller配置一个行为过滤器来执行速率限制检查。如果速度超出限制，该速率限制器将抛出一个yii\web\TooManyRequestsHttpException。
修改frontend/controllers/BookController.php，加入红色标记代码：

复制代码 
namespace frontend\controllers;

use yii\rest\ActiveController;
use yii\web\Response;
use yii\filters\auth\CompositeAuth;
use yii\filters\auth\QueryParamAuth;

use yii\filters\RateLimiter;

class BookController extends ActiveController
{
    public $modelClass = 'frontend\models\Book';

    public function behaviors() {
        $behaviors = parent::behaviors();
        
        $behaviors['rateLimiter'] = [
            'class' => RateLimiter::className(),
            'enableRateLimitHeaders' => true,
        ];
        
        $behaviors['authenticator'] = [
            'class' => CompositeAuth::className(),
            'authMethods' => [
                /*下面是三种验证access_token方式*/
                //1.HTTP 基本认证: access token 当作用户名发送，应用在access token可安全存在API使用端的场景，例如，API使用端是运行在一台服务器上的程序。
                //HttpBasicAuth::className(),
                //2.OAuth 2: 使用者从认证服务器上获取基于OAuth2协议的access token，然后通过 HTTP Bearer Tokens 发送到API 服务器。
                //HttpBearerAuth::className(),
                //3.请求参数: access token 当作API URL请求参数发送，这种方式应主要用于JSONP请求，因为它不能使用HTTP头来发送access token
                //http://localhost/user/index/index?access-token=123
                QueryParamAuth::className(),
            ],
        ];
        $behaviors['contentNegotiator']['formats']['text/html'] = Response::FORMAT_JSON;
        return $behaviors;
    }
}
复制代码

2.在user表中使用两列来记录容差和时间戳信息。为了提高性能，可以考虑使用缓存或NoSQL存储这些信息。
修改common/models/User.php，加入红色标记代码：

复制代码 
namespace common\models;

use Yii;
use yii\base\NotSupportedException;
use yii\behaviors\TimestampBehavior;
use yii\db\ActiveRecord;
use yii\web\IdentityInterface;

use yii\filters\RateLimitInterface;

class User extends ActiveRecord implements IdentityInterface, RateLimitInterface
{

    ....

    // 返回在单位时间内允许的请求的最大数目，例如，[10, 60] 表示在60秒内最多请求10次。
    public function getRateLimit($request, $action)
    {
        return [5, 10];
    }

    // 返回剩余的允许的请求数。
    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();
    }
    
    ....
    
    public static function findIdentityByAccessToken($token, $type = null)
    {
        //throw new NotSupportedException('"findIdentityByAccessToken" is not implemented.');
        //findIdentityByAccessToken()方法的实现是系统定义的
        //例如，一个简单的场景，当每个用户只有一个access token, 可存储access token 到user表的access_token列中， 方法可在User类中简单实现，如下所示：
        return static::findOne(['access_token' => $token]);
    }
    
    ....
}

 

 

转载于:https://www.cnblogs.com/xiong63/p/8548039.html

weixin_30294021
关注
Yii2 RESTful API 开发
weixistyle的博客
11-21 680
本套教程结合实例来讲解《Yii2权威指南》上RESTful API章节的相关知识，力求更容易学会。 WeixiStyle教程的特点是：讲解思路清晰，语言简洁利索，采用案例驱动，大量使用动画、图表和代码帮助理解。 教程共计118分钟，共8章，欢迎收看。如有意见建议或需要视频相关文档，请加我QQ:1576468905沟通交流。 更多课程信息，请参阅魏曦课堂官网：http://www.weixis...
yii2框架-restful的基础入门(二十一)
bingcool
07-28 5548
今天给人的感觉就是“热，很热，热中暑”！ 最近的高温天气简直让人不能活啊，听说华中地区的温度居然超过40度，广东的温度也接近37度，户外工作的真的做好避暑咯！ 趁着今天工作之余，感觉总的写些什么东西。现在回想起来，自己学习编程也接近3年了，从大三开始正式学习php,当时是跟着LAMP兄弟连的老师一边看视频，一边查找资料，一边练习，做些小的模块，比如登录，分页，简单的CURD等等。到后来逐渐接触
RESTful API 设计最佳实践
coder 的历程
06-13 1216
背景 目前互联网上充斥着大量的关于RESTful API（为了方便，以后API和RESTful API 一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？你的API是否应该加入版本信息？当你开始写一个app的时候，特别是后端模型部分已经写完的时候，你不得不殚精竭虑的设计和实现自己app的public API部分。因为一旦发布，对外发布的API将会很难改变。 ...
yii2 RESTful api的详细使用
weixin_34163553的博客
11-14 251
什么是RESTful风格的API 对于各种客户端设备与服务端的通信，我们往往都通过API为客户端提供数据，提供某种资源。关于RESTful的概念，一查一大推，一两句也解释不清，姑且先按照我们通俗的理解：在众多风格、众多原则的API中，RESTful就是一套比较优秀的接口调用方式。 Yii2如何实现RESTful风格的API 1、建立单独的应用程序 为了增加程序的可维护性，易操作性，我们选择...
【PHP】Yii2团队基于接口(interface)开发方式最佳实践
weixin_33725239的博客
03-21 1051
前言 貌似很多公司都转向了使用Yii2做项目开发~ 当团队开发人员过多的时候，对接口的定义就成了困难，再说，命名本来就是个玄学的东西。 之前早就听说过面向接口开发，这几天就试了下，感觉还不错，分享出来，一起进步。 最佳实践 单独存放的文件夹 我把接口文件放在项目中的custominterface中，再和相应控制器所在文件夹进...
yii2 提供接口给java_yii2写api接口步骤
weixin_42350101的博客
02-26 269
yii2写api接口步骤Yii2如何实现RESTful风格的API(推荐：《YII教程》 )1、建立单独的应用程序为了增加程序的可维护性，易操作性，我们选择新建一套应用程序，这也是为了和前台应用、后台应用区分开操作。在WEB前端(frontend)和后端(backend)的同级目录，新建一个文件夹，命名api,其目录结构如下所示：├─assets│ AppAsset.php├─confi...
dw-wx-app.rar
05-23
1. **RESTful API设计**：为方便小程序调用，设计符合RESTful原则的API接口，如用户注册、登录、获取用户信息、更新用户资料等。 2. **Yii2的ActiveRecord**：利用Yii2的ActiveRecord模式，操作数据库更加便捷，例如...
使用Yii2实现API数据过滤和搜索
介绍Yii2框架和RESTful API ## 1.1 什么是Yii2框架 Yii2（Yes It Is 2）是一个用于开发现代Web应用程序的高性能、高扩展性的PHP框架。它采用了MVC设计模式和面向对象的编程风格，提供了丰富的功能和组件，以简化...
Yii2框架入门指南：搭建第一个RESTful接口
Yii2框架采用了强大的面向对象的编程风格，提供了丰富的功能模块和工具，可以帮助开发者快速构建可靠、安全、高效的Web应用。 ## 1.2 Yii2框架的特点和优势 - **高性能和低资源消耗**：Yii2框架采用了先进的缓存...
Yii2简介以及高级模板安装
ITsource
01-21 3183
1.Yii2的简介 1.1.Yii2 是什么 Yii2 是一个高性能，基于组件的 PHP 框架，用于快速开发现代 Web 应用程序。 名字 Yii2 （读作 易）在中文里有“极致简单与不断演变”两重含义，也可看作 Yes It Is! 的缩写。 1.2.Yii2 最适合做什么？ Yii2 是一个通用的 Web 编程框架，即可以用于开发各种用 PHP 构建的 Web 应用。 因为
yii2 restful api --app接口编程
weixin_30856725的博客
03-16 166
转 http://www.yiichina.com/tutorial/1143yii2中restful url访问配置， 登陆接口access-token验证类 [ 2.0 版本 ] 登陆接口access-token验证类 Controller下新建BaseActiveController.php <?php /** *接口登陆验证 * @author ...
yii API接口设计
创客15号
09-30 502
最近使用yii2作为服务器开发, 客户端为android以及C#, JSON格式通信; 使用yii2作为API接口设计中需要注意的几点: 1. Csrf的验证 默认yii2是使用csrf来验证每次的POST请求, 因为我使用了自定义的一套验证方式，所以需要屏蔽掉csrf, 在设置文件config/main.php中 'request' => [ 'csrfParam' => '
极简的Restful API 框架推荐推荐：Resty(服务端+客户端)
腾讯全栈-ITCJF
11-07 2578
resty一款极简的restful轻量级的web框架，拥有jfinal/activejdbc一样的activerecord的简洁设计，使用更简单的restful框架。 拥有jfinal/activejdbc一样的activerecord的简洁设计，使用更简单的restful框架。 restful的api设计，是作为restful的服务端最佳选择（使用场景：客户端和服务端解藕，用于对
前后端分离实战 后端篇 RESTful-API设计
nonlinearthink的博客
05-28 1107
RESTful 架构 2000年 HTTP 规范的主要编写者之一Roy Fielding， 在他的博士论文中提出了 RESTful 的概念。 REST(Representational State Transfer)，中文名叫表述性状态转移。它有以下的几种特征: 资源是一个具体的信息，可以使用一个URI去定位它。 资源不规定形式，同一个资源可以请求到它的HTML、XML、JSON等等不同格式。 URI中不包括动词，只包括名词。 动词由四个标准的HTTP方法: GET(获取资源)、POST(创
Yii2 APP开发之restful教程-王浩-专题视频课程
阿北哥ya
12-27 350
APP、微信小程序、各种UI框架越来越火爆，作为一名后端工程师如何为其提供良好的api接口变得尤为重要，本套课程将为你展示在yii2下使用restful规范轻松实现接口开发。...
yii2框架--yii2的主题化设计(十九)
bingcool
07-04 2557
最近发现漏了很重要的一章章节知识点--关于yii2的主题化设计。所谓的主题话设计简单点说就是通过设置不同的模板主题，可以快速切换，无需更改视图渲染代码的方法。 在yii2中使用主题，首先要配置主题，在components中 'view' => [ 'theme' => [ 'basePath' => '@app/themes/blue', 'base
php smarty restful,Yii2中Restful API原理实例分析
weixin_42356349的博客
03-24 150
本文实例分析了Yii2中Restful API原理。分享给大家供大家参考，具体如下：Yii2 有个很重要的特性是对 Restful API的默认支持， 通过短短的几个配置就可以实现简单的对现有Model的RESTful API这里通过分析rest部分源码，简单剖析下yii2 实现 restful 的原理，并通过一些定制实现 对 关联模型的RESTful api 操作。~ 代表 extends fr...
移动App的REST API设计实践
chuangangliu8460的博客
05-06 99
通讯协议 一些只是对服务器数据进行CRUD操作的App，通常采用HTTP协议，为了安全也可以采用HTTPS协议。IM软件可以选择使用XMPP协议。 其他一些特有场景的App可能基于Socket自定义协议。 SOCKET是实现传输层协议的一种编程API，可以是TCP，也可以是UDP。 ...
App架构设计经验谈:接口的设计
xls51314202005的博客
01-08 1028
App与服务器的通信接口如何设计得好，需要考虑的地方挺多的，在此根据我的一些经验做一些总结分享，旨在抛砖引玉。 [b]安全机制的设计[/b] 现在，大部分App的接口都采用RESTful架构，RESTFul最重要的一个设计原则就是，客户端与服务器的交互在请求之间是无状态的，也就是说，当涉及到用户状态时，每次请求都要带上身份验证信息。实现上，大部分都采用token的认证方式，一般流程是：...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值