saturn/taurus

Small API Platform

Taurus

A simple, small, easy, etcetera, API framework., _(*1)

Installation

With Composer (recommended):

$ composer require saturn/taurus

Setup

Add a .htaccess file to your root directory, to redirect all requests to the file that should launch Taurus, for example:, _(*2)

Options -Indexes
RewriteEngine on
RewriteBase /
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_METHOD} ^(get|post)$ [NC]
RewriteRule ^ index.php [QSA,L]

Create a folder named application at root level. This folder will contain the API(s). The API folder must be named after it's version., _(*3)

The folder structure should look something like this:, _(*4)

- application/
   - 1.0/
     - Resources/
        + Example.php      // The end point
     - Models/
        + ExampleModel.php // The Model file for Example (optional)
     - BaseAPI.php (Each API version must extend the Base API class.)
   - 1.1/
     - Resources/
     - Models/
     - BaseAPI.php
- index.php
- .htaccess

Usage

Run Taurus in your index.php file., _(*5)

use taurus\core\Taurus;

include "vendor/autoload.php";

try {
    new Taurus();
} catch (Exception $e) {
    // Error handling
}

Each API version must extend the BaseAPI class., _(*6)

// Add it to the API version's base folder, i.e. /application/1.0/BaseAPI.php
use taurus\core\BaseAPI;

class API extends BaseAPI {

}

To actually start using Taurus, you need to create Resources with end points., _(*7)

Create Resources & End Points

All resources should be put inside the Resources folder in the appropriate API folder under application. The Resource classes must extend the base class Resource and have a main method (this is the default method called)., _(*8)

Below follows an example on how to create an end point named Example with two end points: Main (/) and remove., _(*9)

// /application/1.0/Resources/Example.php
// This end point is accessible by calling: http://api.example.dev/1.0/Example or:
//                                          http://api.example.dev/1.0/Example/remove/15
use taurus\core\Resource;

class Example extends Resource {

    protected function main() {
        $data = $this->model->getExamples($id);

        if (isset($data["error"])) {
            $data = $data["error"];
            $this->statusCode = 500;
        }

        $this->response($data, $this->statusCode);
    }

    protected function remove() {
        $id = $this->arguments[0];

        if (isset($id)) {
            $response = $this->model->deleteExample($id);
            $this->statusCode = 200;
        } else {
            $response = "No id given";
            $this->statusCode = 400;
        }

        $this->response($response, $this->statusCode);
    }

}

Create Models for your Resources

All business logic should be put inside a model class. Models must be paired with exactly one resource file and have the same name, followed by "Model", and extend the base model class Model., _(*10)

Taurus includes a database wrapper class, accessible through the class property database defined in Model. See Database for more information on how to use the database connection., _(*11)

To connect to the database, you must first define and set the following constants in your config file: - kHostname: The hostname on which the database server resides. - kDatabase: The name of the database. - kUsername: The username. - kPassword: The password., _(*12)

Below is an example on how to use a model, based on the example above., _(*13)

// /application/1.0/Resources/ExampleModel.php
use taurus\core\Model;

class ExampleModel extends Model {

    public function getExamples() {
        $query = "SELECT name FROM Examples";
        return $this->database->read($query);
    }

    public function deleteExample($id) {
        $query = "DELETE FROM Examples WHERE id = :id";
        $param = array("id"  => $id);

        $response = $this->database->write($query, $param);

        return $response;
    }

}

Author

Taurus was created by Ardalan Samimi., _(*14)