geogkary/breeze

Use Breeze to quickly setup and start building JSON APIs with PHP. A lightweight framework that takes care of versioning and routing, built on top of mikecao/flight.

v1.0.4-beta 2020-05-17 14:10 UTC

This package is auto-updated.

Last update: 2021-05-19 12:17:42 UTC


README

Use Breeze to quickly setup and start building JSON APIs with PHP. Breeze is a lightweight framework that takes care of versioning and routing, built on top of mikecao/flight.

Requires PHP 5.6 or greater.

Released under the MIT License.

How to Install

See available versions on GitHub / Packagist.

Manually

Download Breeze OR clone the repo in your project's root directory:

git clone https://github.com/geogkary/breeze.git

Download Flight OR clone the repo inside engine/flight/:

cd engine/flight/
git clone https://github.com/mikecao/flight.git

Run Breeze:

require 'engine/Breeze.php';
Breeze::init();

Composer

Require and load the package:

composer require geogkary/breeze v1.0.4-beta
// autoload
require 'vendor/autoload.php';

// manually
require 'vendor/geogkary/breeze/engine/composer.php';

How to Start

First things first, create a subidrectory versions/ inside your project's root directory.

You can download the boilerplate API version, so you don't have to start from scratch. Just unzip inside the subdirectory. Edit config.php located in Breeze's root directory.

That's it.

(PS: Undestand how to use Breeze in 5 minutes)

Thanks