Skip to content
Youmy001 edited this page Feb 4, 2018 · 26 revisions

About APIne Framework

APIne is a simple to use modular MVC Framework ready for use as a RESTful API. It intends to be a general purpose framework and a RESTful service providing basic session management, authentication, routing, and database abstraction without including useless tools. APIne's focus is to let you work without imposing to relearn PHP.

You may per se, use APIne for solely for its routing system and its MVC approach then use your favorite PHP libraries for everything else.

APIne already implements a comprehensive session manager, a basic yet effective Entity manager, and, TWIG as its template manager — enough to boot any kind of project.

What is MVC?

MVC or Model-View-Controller is a architectural pattern mainly used for web applications. It seperates the way data is managed from its output representation, and the way input are captured and the commands to models and views. In PHP, this pattern solves the problem of getting a good structure to work on.

On APIne Framework, Model represents the way data are managed, View is the output representation, and Controller commands both the Model and the View.

Requirements

For APIne 1.1 and 1.2

  • PHP 5.6 or greater;
  • MySQL 5.6 or MariaDB 10.1 or greater;
  • Apache 2.4 with mod_rewrite.

Planned of APIne 2.0

  • PHP 7.0 or greater with PDO extension
  • MySQL 5.6 or MariaDB 10.1 or greater
  • Apache 2.4 with mod_rewrite

Quick Start

Installing APIne is rather easy. The best way to install is through its Composer package.

Add the following line to your composer.json file :

“youmy001/apine-framework”: “^1.1”

Or use the following command :

composer require youmy001/apine-framework

Next, create a new database for APIne if you don't already have one yet, then execute the assistant in a web browser (http://[domain_name_of_your_project]/vendor/youmy001/apine-framework/install.php) and follow the instruction on screen.

Framework Documentation