Download the PHP package saturn/taurus without Composer
On this page you can find all versions of the php package saturn/taurus. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download saturn/taurus
More information about saturn/taurus
Files in saturn/taurus
Package taurus
Short Description Small API Platform
License GPL-2.0
Homepage https://github.com/pkrll/Taurus
Informations about the package taurus
Taurus

A simple, small, easy, etcetera, API framework.
Installation
With Composer (recommended):
Setup
Add a .htaccess file to your root directory, to redirect all requests to the file that should launch Taurus, for example:
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.
The folder structure should look something like this:
Usage
Run Taurus in your index.php
file.
Each API version must extend the BaseAPI class.
To actually start using Taurus, you need to create Resources
with end points.
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).
Below follows an example on how to create an end point named Example
with two end points: Main (/
) and remove.
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
.
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.
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.
Below is an example on how to use a model, based on the example above.
Author
Taurus was created by Ardalan Samimi.