hiqdev/hiapi

HiAPI Yii2 base project for building API

dev-master 2023-09-27 11:55 UTC

Requires

• php: ^7.4 || ^8.0
• doctrine/collections: ^1.6.4
• guzzlehttp/psr7: ^1.9 || ^2.0
• hiqdev/yii-compat: dev-master
• hiqdev/yii2-autobus: dev-master
• hiqdev/yii2-data-mapper: dev-master
• league/event: ^2.1
• php-amqplib/php-amqplib: ^3.0.0
• psr/container: ^1.0
• psr/http-server-middleware: ^1.0.1
• psr/log: ^1|^2
• ramsey/uuid: ^3.0 | ^4.0
• vlucas/phpdotenv: ^2.4 || ^5.3.1
• yiisoft/event-dispatcher: ^1.0
• yiisoft/request-body-parser: dev-master

Requires (Dev)

• cebe/php-openapi: ^1.4.0
• doctrine/collections: ^1.6.4
• hiqdev/hidev-hiqdev: dev-master
• hiqdev/hidev-php: dev-master
• laminas/laminas-diactoros: ^2.2
• laminas/laminas-httphandlerrunner: ^1.1
• middlewares/negotiation: ^2.0
• phpunit/phpunit: ^7.5.17
• relay/relay: 2.0.0
• vimeo/psalm: ^3.8.3

Suggests

• aura/router: To use AuraRouterController
• laminas/laminas-diactoros: To handle CLI request and use some Middlewares
• laminas/laminas-httphandlerrunner: To use HTTP request handlers
• lcobucci/content-negotiation-middleware: To use ContentNegotiation Middleware
• middlewares/negotiation: To use ContentNegotiation Middleware
• relay/relay: To use HTTP Request handlers
• woohoolabs/yin: To work with JsonAPI requests/responses

BSD-3-Clause

• Andrii Vasyliev
• Dmitry Naumenko
• Andrey Klochok
• Yuriy Myronchuk

• api
• core
• yii2
• hiapi

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/)