Yii2框架制作RESTful风格的API快速入门教程

2019-05-02 15:33:32于丽

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

namespace frontendmodels;
use yiidbActiveRecord;
class Book extends ActiveRecord
{
public static function tableName()
{
return 'book';
}
}

四、创建一个控制器

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

namespace frontendcontrollers;
use yiirestActiveController;
class BookController extends ActiveController
{
public $modelClass = 'frontendmodelsBook';
}

五、测试

到这里,我们就已经完成了创建用于访问用户数据 的 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 将在末端使用的控制器的名称自动变为复数。这是因为 yiirestUrlRule 能够为他们使用的末端全自动复数化控制器。可以通过设置yiirestUrlRule::pluralize为false来禁用此行为:

'rules' => [
['class' => 'yiirestUrlRule', 'controller' => 'book', 'pluralize' => false],
],

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

以上所述是小编给大家介绍的Yii2框架制作RESTful风格的API快速入门教程,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对易采站长站网站的支持!

相关文章 大家在看