PHPackages                             harryzheng0907/yii2-rest - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. harryzheng0907/yii2-rest

ActiveYii2-extension[API Development](/categories/api)

harryzheng0907/yii2-rest
========================

The enhanced restful api for Yii Framework 2.0

4613PHP

Since Nov 11Pushed 10y ago1 watchersCompare

[ Source](https://github.com/HarryZheng0907/yii2-rest)[ Packagist](https://packagist.org/packages/harryzheng0907/yii2-rest)[ RSS](/packages/harryzheng0907-yii2-rest/feed)WikiDiscussions master Synced 3w ago

READMEChangelogDependenciesVersions (1)Used By (0)

概述
--

[](#概述)

这个扩展主要是用于增强Yii2 rest api中IndexAction的功能.

相对于官方的IndexAction，该扩展主要增加了以下几个功能

1.搜索功能

```
http://url/users?id=1&username=LIKE_dmi&created_at=MAX_1398153715&addresses.city=南京

```

2.显示多级子资源(官方只支持二级子资源（通过expand关键字指定），如users?expand=address）

```
http://url/users?expand=addresses,friends.addresses&expand-fields=addresses.phone,friends.addresses

```

3.允许通过子资源排序

```
http://url/users?sort=addresses.phone DESC,id ASC

```

4.允许为子资源的表设置别名（防止两个不同的子资源取同一张表时的命名冲突）

```
use harryzheng0907\rest\ActiveRecord;

class User extends ActiveRecord
{
    public static function tableName()
    {
        return 'user';
    }

    public function getMainAddresses()
    {
        return $this->hasMany(Address::className(), ['user_id' => 'id'],'mainAddresses');
    }
    public function getOtherAddresses()
    {
        return $this->hasMany(Address::className(), ['user_id' => 'id'],'otherAddresses');
    }
}

```

安装
--

[](#安装)

通过 [composer](http://getcomposer.org/download/)安装

```
php composer.phar require harryzheng0907/yii2-rest

```

使用
--

[](#使用)

#### 使用概述

[](#使用概述)

使用方式其实就是两点

1. 将IndexAction指向harryzheng0907\\rest\\IndexAction
2. 使用的AR Model要继承自harryzheng0907\\rest\\ActiveRecord

#### 详细步骤

[](#详细步骤)

1.新建一个全局父Controller,继承ActiveController，重新指定IndexAction

```
namespace app\controllers;

use yii\helpers\ArrayHelper;

class ActiveController extends \yii\rest\ActiveController {
    public function actions()
    {
        return ArrayHelper::merge(parent::actions(),[
            'index' => [
                'class' => 'harryzheng0907\rest\IndexAction'
            ]
        ]);
    }
}

```

2.新建特定资源的AR Model，继承harryzheng0907\\rest\\ActiveRecord，如user

```
namespace app\models;

use Yii;
use harryzheng0907\rest\ActiveRecord;

class User extends ActiveRecord
{
    public static function tableName()
    {
        return 'user';
    }
}

```

3.新建特定资源的controller，如user，继承第一步新建的全局controller

```
namespace app\controllers;

class UserController extends \app\controllers\ActiveController {
    public $modelClass = 'app\models\User';
}

```

4.完成

搜索方式
----

[](#搜索方式)

```
EQUAL:http://url/users?username=EQUAL_a  // username = 'a'
NOTEQUAL:http://url/users?username=NOTEQUAL_a  // username != 'a'
NULL:http://url/users?username=NULL_  // username IS NULL
LIKE:http://url/users?username=LIKE_a  //username LIKE '%a%'
LLIKE:http://url/users?username=LLIKE_a  //username LIKE '%a'
RLIKE:http://url/users?username=RLIKE_a  //username LIKE 'a%'
IN:http://url/users?username=IN_a,b,c  //username IN ('a','b','c')
NOTIN:http://url/users?username=NOTIN_a,b,c  //username NOT IN ('a','b','c')
MIN:http://url/users?age_min=MIN_10  // age >= 10
MAX:http://url/users?age_max=Max_60  //age hasMany(Address::className(), ['user_id' => 'id'],'mainAddresses');
    }
    public function getOtherAddresses()
    {
        return $this->hasMany(Address::className(), ['user_id' => 'id'],'otherAddresses');
    }
}

```

2.设置排序时，DESC/ASC不可省略

###  Health Score

23

—

LowBetter than 26% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity15

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/8df364ac596e81ad43c8af382a960ad19355561db9fafcb20ff23f6c57481251?d=identicon)[HarryZheng0907](/maintainers/HarryZheng0907)

---

Top Contributors

[![HarryZheng0907](https://avatars.githubusercontent.com/u/8669557?v=4)](https://github.com/HarryZheng0907 "HarryZheng0907 (7 commits)")

### Embed Badge

![Health badge](/badges/harryzheng0907-yii2-rest/health.svg)

```
[![Health](https://phpackages.com/badges/harryzheng0907-yii2-rest/health.svg)](https://phpackages.com/packages/harryzheng0907-yii2-rest)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35816.3M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24015.5M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93452.6k6](/packages/botman-driver-telegram)[pixelant/pxa-social-feed

Add Facebook, Instagram, and Twitter feeds to your site.

2349.3k](/packages/pixelant-pxa-social-feed)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)