vxm/yii2-gateway-clients

An abstraction layer provide the skeleton for build rest api client (1-n).

2.0.1 2018-10-09 15:43 UTC

This package is auto-updated.

Last update: 2023-01-15 18:28:17 UTC


README

Skeleton for build rest api client (1-n).

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

This Yii2 extension is an abstraction layer provide the skeleton for build an api client (1-n).

Requirements

Installation

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

composer require "vxm/yii2-gateway-clients"

or add

"vxm/yii2-gateway-clients": "*"

to the require section of your composer.json.

Usage

This is an abstraction layer, you MUST be create your own classes implements it. It designed for DRY principle when you need to build rest api client.

Abstract Classes Introduce

An abstract classes have been designed for implemented an interfaces. You should extends it for easier implements interfaces on your own classes.

Abstract Class Details
BaseGateway Implemented GatewayInterface, abstract method your own class must create: requestInternal, getBaseUrl.
BaseClient Implemented ClientInterface, it not have an abstract method your own class should add properties an information for access gateway server api.
ResponseData Abstract method your own class must create is getIsOk for end-user checking response data get from gateway server api is valid or not.

Need an example?

Click here to read simple example.

Project using it