Yii2实现RESTful风格的API中要注意的坑有哪些呢
admin
2023-06-13 05:42:12
0次

Yii2实现RESTful风格的API的流程如下:
1、WEB前端(frontend)和后端(backend)的同级目录,新建一个文件夹,命名api,api中文件完全复制一份原始的backend中文件即可

2、需要修改common\config\bootstrap.php文件,对新建的应用增加alias别名

Yii::setAlias('@api', dirname(dirname(DIR)) . '/api');

3、保证你的web服务器开启rewrite规则!配置apache或nginx!这里请google或百度下。
nginx中在conf文件夹中vhost.conf或nginx.conf中相关位置加入:

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

apache中在对应的api/web(域名指向的服务器目录中)加入.htaccess:

RewriteEngine on

RewriteCond %{REQUEST_FILENAME} !-d

RewriteCond %{REQUEST_FILENAME} !-f

RewriteRule . index.php

4、api应用程序美化路由(注意里面的括弧、名字的大小写,类名习惯驼峰式,但是controller 对应的控制器名一定要小写)
接着配置api/config/main.php文件

'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'enableStrictParsing' => true,

        'rules' => [
            ['class'=>'yii\rest\UrlRule','controller'=>'article'],
        ],
    ],

如果担心影响其他访问地址(如gii无法连接)可以先注释'enableStrictParsing' =>true,传到服务器后开启即可(增加安全性)

5、准备工作好啦,开始写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 标题

  • @property string $content 内容

  • @property int $category_id 分类

  • @property int $status 状态

  • @property int $created_by 创建人

  • @property int $created_at 创建时间

  • @property int $updated_at 最后修改时间
    */
    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、访问链接查看接口返回值:
http://www.xxx.com/articles  已经能够很方便的获取我们表中的数据了。
当然,yii2还对该api封装了如下操作:

GET /articles: 逐页列出所有用户
HEAD /articles: 显示用户列表的概要信息
POST /articles: 创建一个新用户
GET /articles/123: 返回用户 123 的详细信息
HEAD /articles/123: 显示用户 123 的概述信息
PATCH /articles/123 and PUT /users/123: 更新用户123
DELETE /articles/123: 删除用户123
OPTIONS /articles: 显示关于末端 /users 支持的动词
OPTIONS /articles/123: 显示有关末端 /users/123 支持的动词

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...