taktwerk/tw-yii2-rest

基于 HarryZheng0907 的 yii2-rest 的 Yii Framework 2.0 增强型 Restful API

维护者

详细信息

github.com/taktwerk/tw-yii2-rest

源代码

问题

维基

安装次数: 3,436

依赖项: 0

建议者: 0

安全: 0

星标: 0

关注者: 3

分支: 0

开放性问题: 0

类型:yii2-extension

v1.0.2 2016-02-22 13:36 UTC

Requires

BSD e1e5749b1865a2e079aa4c96d4bade264149d85f

  • Taktwerk <j.payne.woop@taktwerk.ch>

restapirestfulyii2

This package is not auto-updated.

Last update: 2024-09-28 19:47:23 UTC

README

#TW-Yii2-Rest

从 HarryZheng0907 的 yii-rest 分支并修改而来。

此包为您的 Yii2 ActiveControler 的 index 动作添加了一些实用的搜索选项。

功能

  1. 搜索能力
http://url/users?id=1&username=LIKE_dmi&created_at=MAX_1398153715&addresses.city=南京
  1. 多级关系展开
http://url/users?expand=addresses,friends.addresses&expand-fields=addresses.phone,friends.addresses
  1. 按子关系排序
http://url/users?sort=addresses.phone DESC,id ASC
  1. 分组
http://url/rooms?group=building.building_id=4

安装

php composer.phar require taktwerk/tw-yii2-rest

使用方法

IndexAction

将您的 Active Controlers 的 IndexAction 更改为指向 taktwerk\rest\IndexAction

示例

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 <= 60
RANGE:http://url/users?birthdate=RANGE_2015-03  //birthdate<=2015-03-31 AND birthdate >= 2015-03-01