ActiveRecord for API

Latest Stable Version Total Downloads Build Status Scrutinizer Code Coverage Scrutinizer Code Quality Dependency Status

This Yii2 extension provides ActiveRecord implementation that allows to access remote/web API same way as you do with normal Yii2 DB ActiveRecord.


The preferred way to install this yii2-extension is through composer.

composer require "hiqdev/yii2-hiart"

But if you prefer Guzzle transport use yii2-hiart-guzzle package:

composer require "hiqdev/yii2-hiart-guzzle"


To use this extension, configure hiart component in your application config:

    'components' => [
        'hiart' => [
            'class' => \hiqdev\hiart\rest\Connection::class,
            'requestClass' => \hiqdev\hiart\auto\Request::class,
            'baseUri' => 'https://site.com/api/v3/',

Note three main options:


Available transports are:

You can implement your own transport. All you need is to create two classes: Request and Response, it's not difficult see available implementations. Transport can be even non-HTTP based.

Query builders

QueryBuilder is what actually implements an API.

We are developing QueryBuilders for:

You can implement your own API. Basically all you need is create your QueryBuilder class with these methods:

See available implementations and ask questions using issues on GitHub.


Define your Model:

class User extends \hiqdev\hiart\ActiveRecord
    public function rules()
        return [
            ['id', 'integer', 'min' => 1],
            ['login', 'string', 'min' => 2, 'max' => 32],

Note that you use general hiqdev\hiart\ActiveRecord class not specific for certain API. API is specified in connection options and you don't need to change model classes when you change API.

Then you just use your models same way as DB ActiveRecord models.

$user = new User();
$user->login = 'sol';


$admins = User::find()->where(['type' => User::ADMIN_TYPE])->all();

Basically all the features of Yii2 ActiveRecord work if your API provides them.


This project is released under the terms of the BSD-3-Clause license. Read more here.

Copyright © 2015-2017, HiQDev (http://hiqdev.com/)