PHPackages                             ghiyam/apix - 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. ghiyam/apix

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

ghiyam/apix
===========

Yii2 module supporting universal client-server requests to the external API

2.0.6(2y ago)22991[1 PRs](https://github.com/Ghiya/apix/pulls)MITPHPPHP >=7.2.0

Since May 29Pushed 2y ago1 watchersCompare

[ Source](https://github.com/Ghiya/apix)[ Packagist](https://packagist.org/packages/ghiyam/apix)[ RSS](/packages/ghiyam-apix/feed)WikiDiscussions 2.0 Synced 1mo ago

READMEChangelogDependencies (2)Versions (22)Used By (0)

APIx
====

[](#apix)

[![2.0.6](https://camo.githubusercontent.com/1220c8b8a1b8e5836e9dfb1c03b7014d86bbafc714f97ed0618fafe1660c1f5c/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d6c6174657374266d6573736167653d322e302e3626636f6c6f723d303036453930267374796c653d666c61742d737175617265)](https://camo.githubusercontent.com/1220c8b8a1b8e5836e9dfb1c03b7014d86bbafc714f97ed0618fafe1660c1f5c/68747470733a2f2f696d672e736869656c64732e696f2f7374617469632f76313f6c6162656c3d6c6174657374266d6573736167653d322e302e3626636f6c6f723d303036453930267374796c653d666c61742d737175617265)

Универсальный плагин динамических клиент-серверных запросов к API внешних сервисов в приложениях [Yii2 framework](https://www.yiiframework.com/).

Как это работает?
-----------------

[](#как-это-работает)

Плагин `APIx` является [модулем](https://www.yiiframework.com/doc/guide/2.0/en/structure-modules) и отвечает при обработке запросов за конфигурацию сервисов API и соответствующий роутинг. Каждый сервис представлен [контроллером](https://www.yiiframework.com/doc/guide/2.0/en/structure-controllers) и его [действия](https://www.yiiframework.com/doc/guide/2.0/en/structure-controllers#actions) определяют запросы к API этого сервиса. Плагин содержит объекты интегрированных клиентов для cURL/SOAP/SMPP соединений с API, которые предполагается наследовать в конкретных реализациях.

Конфигурация сервисов
---------------------

[](#конфигурация-сервисов)

Каждый из сервисов API представляется соответствующим контроллером, поэтому все используемые сервисы конфигурируются в параметре `controllerMap` модуля плагина. Действие контроллера должно возвращать массив параметров запроса/запросов в формате указанном ниже.

> Note: Для корректной работы контроллера сервиса API требуется унаследовать его от \[\\ghiyam\\apix\\controllers\\ServiceController\].

```
[
    // ...
    'modules'    =>
        [
            'apix' => [
                'class' => 'ghiyam\apix\APIx',
                'controllerMap' => [
                    // API service with REST client example
                    'some_vendor'    =>
                        [
                            // default controller class is abstract, use inheritance instead
                            'class'      => 'ghiyam\apix\controller\ServiceController',
                            'service' =>
                                [
                                    'client' => [
                                        // default client class is abstract, use inheritance instead
                                        'class'         => '\ghiyam\apix\clients\CurlApiClient',
                                        'credentials'   => [],
                                        'clientOptions' => [
                                            'host'    => 'someHost',
                                            'port'    => 443,
                                            'uri'     => 'path/to/api/uri',
                                            'timeout' => 3,
                                        ]
                                    ],
                                ],
                        ],
                    // API service with SOAP client example
                    'another_vendor' =>
                        [
                            // default controller class is abstract, use implementation instead
                            'class'      => 'ghiyam\apix\controller\ServiceController',
                            'service' =>
                                [
                                    'client' => [
                                        // default client class is abstract, use inheritance instead
                                        'class'       => '\ghiyam\apix\clients\SoapApiClient',
                                        'credentials' => [],
                                        'namespaces'  =>
                                            [
                                                'header'   => '',
                                                'envelope' => '',
                                            ],
                                        'clientOptions' => [
                                            'location'     => '',
                                            'uri'          => '',
                                            'trace'        => true,
                                            'compression'  => SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP,
                                            'exceptions'   => false,
                                            'soap_version' => SOAP_1_1,
                                            'encoding'     => 'UTF-8',
                                        ],
                                    ],
                                ],
                        ]
                    // ... any other API clients implementations...
                ],
            ],
        ],
    //...
]
```

Построение запросов
-------------------

[](#построение-запросов)

Каждый запрос должен содержать обязательный параметр `method` и необязательные параметры `params`. Первый содержит название метода в обращении к сервису API, второй - его параметры.

Пример построения запроса

```

[
    'method' => '',
    'params' =>
        [
            '' => ''
            // ... API method params here ...
        ]
]

```

###  Health Score

31

—

LowBetter than 68% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity67

Established project with proven stability

 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.

###  Release Activity

Cadence

Every ~109 days

Recently: every ~204 days

Total

20

Last Release

829d ago

Major Versions

v0.2.9 → v1.0.12019-05-23

1.2 → 2.0.02021-09-18

PHP version history (2 changes)v0.2.2PHP >=5.5.0

2.0.0PHP >=7.2.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/4186ad899258b4583fbf9490e9a2d3662b57b352d5c469325c4589db7a0a0045?d=identicon)[Ghiya](/maintainers/Ghiya)

---

Top Contributors

[![Ghiya](https://avatars.githubusercontent.com/u/8424672?v=4)](https://github.com/Ghiya "Ghiya (60 commits)")

---

Tags

apiyii2module

### Embed Badge

![Health badge](/badges/ghiyam-apix/health.svg)

```
[![Health](https://phpackages.com/badges/ghiyam-apix/health.svg)](https://phpackages.com/packages/ghiyam-apix)
```

###  Alternatives

[dotzero/yii2-amocrm

Расширение для Yii Framework 2 реализующее клиент для работы с API amoCRM

1639.7k](/packages/dotzero-yii2-amocrm)[skeeks/yii2-google-api

Component for work with google api based on google/apiclient

1243.1k1](/packages/skeeks-yii2-google-api)[kun391/yii2-paypal

Process with Paypal

161.6k](/packages/kun391-yii2-paypal)

PHPackages © 2026

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