https://github.com/hiqdev/hiapi

HiAPI Yii2 base project for building API
https://github.com/hiqdev/hiapi

api hacktoberfest project yii2

Last synced: about 1 month ago
JSON representation

HiAPI Yii2 base project for building API

• Host: GitHub
• URL: https://github.com/hiqdev/hiapi
• Owner: hiqdev
• License: bsd-3-clause
• Created: 2017-04-05T10:11:59.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-09-27T11:55:26.000Z (about 1 year ago)
• Last Synced: 2024-11-14T17:50:26.441Z (about 1 month ago)
• Topics: api, hacktoberfest, project, yii2
• Language: PHP
• Homepage:
• Size: 355 KB
• Stars: 5
• Watchers: 5
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# HiAPI

**HiAPI - base project for building API**

[![Latest Stable Version](https://poser.pugx.org/hiqdev/hiapi/v/stable)](https://packagist.org/packages/hiqdev/hiapi)

[![Total Downloads](https://poser.pugx.org/hiqdev/hiapi/downloads)](https://packagist.org/packages/hiqdev/hiapi)

[![Build Status](https://img.shields.io/travis/hiqdev/hiapi.svg)](https://travis-ci.org/hiqdev/hiapi)

[![Scrutinizer Code Coverage](https://img.shields.io/scrutinizer/coverage/g/hiqdev/hiapi.svg)](https://scrutinizer-ci.com/g/hiqdev/hiapi/)

[![Scrutinizer Code Quality](https://img.shields.io/scrutinizer/g/hiqdev/hiapi.svg)](https://scrutinizer-ci.com/g/hiqdev/hiapi/)

[![Dependency Status](https://www.versioneye.com/php/hiqdev:hiapi/dev-master/badge.svg)](https://www.versioneye.com/php/hiqdev:hiapi/dev-master)

HiAPI is a base project for building API.

## Installation

The preferred way to install this yii2-extension is through [composer](http://getcomposer.org/download/).

Either run

```sh

php composer.phar require "hiqdev/hiapi"

```

or add

```json

"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](LICENSE).

Read more [here](http://choosealicense.com/licenses/bsd-3-clause).

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