README

HiAPI - base project for building API

HiAPI is a base project for building API.

Installation

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

Either run

php composer.phar require "hiqdev/hiapi"

or add

"hiqdev/hiapi": "*"

to the require section of your composer.json.

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.

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