本篇文章給大家分享的是有關(guān)Yii2實(shí)現(xiàn)RESTful風(fēng)格的API中要注意的坑有哪些呢,小編覺(jué)得挺實(shí)用的,因此分享給大家學(xué)習(xí),希望大家閱讀完這篇文章后可以有所收獲,話不多說(shuō),跟著小編一起來(lái)看看吧。
成都創(chuàng)新互聯(lián)公司是專業(yè)的廣陽(yáng)網(wǎng)站建設(shè)公司,廣陽(yáng)接單;提供做網(wǎng)站、網(wǎng)站制作,網(wǎng)頁(yè)設(shè)計(jì),網(wǎng)站設(shè)計(jì),建網(wǎng)站,PHP網(wǎng)站建設(shè)等專業(yè)做網(wǎng)站服務(wù);采用PHP框架,可快速的進(jìn)行廣陽(yáng)網(wǎng)站開(kāi)發(fā)網(wǎng)頁(yè)制作和功能擴(kuò)展;專業(yè)做搜索引擎喜愛(ài)的網(wǎng)站,專業(yè)的做網(wǎng)站團(tuán)隊(duì),希望更多企業(yè)前來(lái)合作!
Yii2實(shí)現(xiàn)RESTful風(fēng)格的API的流程如下:
1、WEB前端(frontend)和后端(backend)的同級(jí)目錄,新建一個(gè)文件夾,命名api,api中文件完全復(fù)制一份原始的backend中文件即可
2、需要修改common\config\bootstrap.php文件,對(duì)新建的應(yīng)用增加alias別名
Yii::setAlias('@api', dirname(dirname(DIR)) . '/api');
3、保證你的web服務(wù)器開(kāi)啟rewrite規(guī)則!配置apache或nginx!這里請(qǐng)google或百度下。
nginx中在conf文件夾中vhost.conf或nginx.conf中相關(guān)位置加入:
location / {
try_files $uri $uri/ /index.php$is_args$args;
}
apache中在對(duì)應(yīng)的api/web(域名指向的服務(wù)器目錄中)加入.htaccess:
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule . index.php
4、api應(yīng)用程序美化路由(注意里面的括弧、名字的大小寫(xiě),類名習(xí)慣駝峰式,但是controller 對(duì)應(yīng)的控制器名一定要小寫(xiě))
接著配置api/config/main.php文件
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'enableStrictParsing' => true,'rules' => [ ['class'=>'yii\rest\UrlRule','controller'=>'article'], ], ],
如果擔(dān)心影響其他訪問(wèn)地址(如gii無(wú)法連接)可以先注釋'enableStrictParsing' =>true,傳到服務(wù)器后開(kāi)啟即可(增加安全性)
5、準(zhǔn)備工作好啦,開(kāi)始寫(xiě)conroller與model:
在www根目錄-->common-->models中新建文件Article.php(可以使用Gii)
namespace common\models;
use Yii;
/**
This is the model class for table "article".
@property int $id ID
@property string $title 標(biāo)題
@property string $content 內(nèi)容
@property int $category_id 分類
@property int $status 狀態(tài)
@property int $created_by 創(chuàng)建人
@property int $created_at 創(chuàng)建時(shí)間
@property int $updated_at 最后修改時(shí)間
*/
class Article extends \yii\db\ActiveRecord
{
/**/**
/**
@inheritdoc
*/
public function attributeLabels()
{
return [
'id' => 'ID',
'title' => 'Title',
'content' => 'Content',
'category_id' => 'Category ID',
'status' => 'Status',
'created_by' => 'Created By',
'created_at' => 'Created At',
'updated_at' => 'Updated At',
];
}
}@inheritdoc
*/
public function rules()
{
return [
[['id', 'title', 'content'], 'required'],
[['id', 'category_id', 'status', 'created_by', 'created_at', 'updated_at'], 'integer'],
[['content'], 'string'],
[['title'], 'string', 'max' => 512],
];
}@inheritdoc
*/
public static function tableName()
{
return 'article';
}
然后在api中controllers中新建文件:ArticleController.php
namespace api\controllers;
use yii\rest\ActiveController;
use common\models\Article;
/**
*/
class ArticleController extends ActiveController
{// function __construct(argument)
// {
// # code...
// }
public $modelClass='\common\models\Article';
}
6、訪問(wèn)鏈接查看接口返回值:
http://www.xxx.com/articles 已經(jīng)能夠很方便的獲取我們表中的數(shù)據(jù)了。
當(dāng)然,yii2還對(duì)該api封裝了如下操作:
GET /articles: 逐頁(yè)列出所有用戶
HEAD /articles: 顯示用戶列表的概要信息
POST /articles: 創(chuàng)建一個(gè)新用戶
GET /articles/123: 返回用戶 123 的詳細(xì)信息
HEAD /articles/123: 顯示用戶 123 的概述信息
PATCH /articles/123 and PUT /users/123: 更新用戶123
DELETE /articles/123: 刪除用戶123
OPTIONS /articles: 顯示關(guān)于末端 /users 支持的動(dòng)詞
OPTIONS /articles/123: 顯示有關(guān)末端 /users/123 支持的動(dòng)詞
以上就是Yii2實(shí)現(xiàn)RESTful風(fēng)格的API中要注意的坑有哪些呢,小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘9ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。