2017 © Pedro Peláez
 

yii2-extension hiapi

HiAPI Yii2 base project for building API

image

hiqdev/hiapi

HiAPI Yii2 base project for building API

  • Tuesday, June 19, 2018
  • by hiqdev
  • Repository
  • 4 Watchers
  • 3 Stars
  • 568 Installations
  • PHP
  • 2 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 18 % Grown

The README.md

HiAPI

HiAPI - base project for building API, (*1)

Latest Stable Version Total Downloads Build Status Scrutinizer Code Coverage Scrutinizer Code Quality Dependency Status, (*2)

HiAPI is a base project for building API., (*3)

Installation

The preferred way to install this yii2-extension is through composer., (*4)

Either run, (*5)

php composer.phar require "hiqdev/hiapi"

or add, (*6)

"hiqdev/hiapi": "*"

to the require section of your composer.json., (*7)

Overview

  • Endpoint - describes an endpoint:
    • name and description
    • availability: web, console, ...
    • authorization
    • input it takes - Command
    • output it returns - Result
    • execution conveyor: Middlewares and Action
  • Command - describes and holds input data
  • Action - takes Command and returns Result
  • Result - describes and holds output data

License

This project is released under the terms of the BSD-3-Clause license. Read more here., (*8)

Copyright © 2017, HiQDev (http://hiqdev.com/), (*9)

The Versions