Wallogit.com
2017 © Pedro Peláez
A micro-framework written in PHP that will help you build RESTful APIs.
A micro-framework written in PHP that will help you build RESTful APIs., (*1)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system., (*2)
Some things that you need, (*3)
MySQL Server Web Server Composer
Make sure composer is installed on your machine and the $HOME/.composer/vendor/bin directory is in your $PATH so the srest executable can be located by your system., (*4)
Download the SimplyREST installer via composer, (*5)
composer global require vinceurag/sr_installer
Initialize a new app, (*6)
srest new myapi
Verify that your web server and mysql is started., (*7)
Modify config/database.php with your database details., (*8)
$db['host'] = 'localhost'; $db['user'] = 'root'; $db['password'] = ''; $db['database'] = 'test_db';
Test if it's working.
Go to <server>/<directory where you put this project>/SimplyREST/
For example you're using XAMPP and you cloned this project to htdocs, you need to go to, (*9)
http://localhost/myapi/
You should see something like:, (*10)
{
"status" : "successful",
"details" : "framework was installed successfully"
}
Play around with the controllers on /api, (*11)
DO NOT MODIFY ANYTHING IN THE /core FOLDER AND index.php
SAMPLE DATABASE SCHEMA IN config/test_db.sql
Controllers are located under /api
Every controller MUST extend the SR_Controller., (*12)
This REST server supports the most common 4 HTTP Methods: GET, POST, PUT, DELETE., (*13)
When creating a function, this should be the format: HTTPMETHOD_functionname(). For example, get_name().
If the user accessed /name using the GET method, this method will be invoked. Else, if the user accessed it via POST method, the post_name will be invoked., (*14)
To send a response, use the function:, (*15)
$this->sendResponse($arrayData, HTTP_Status::HTTP_OK)
$this->sendResponse() takes in two parameters, the data you want to be the response body (in array) and a status code., (*16)
Status codes are defined in core/HTTP_Status.php, (*17)
HTTP_OK = 200 HTTP_CREATED = 201 HTTP_NOT_FOUND = 404 HTTP_UNAUTHORIZED = 401
To access the POST or PUT json sent to the server, use the function:, (*18)
$anyVariable $this->getJsonData()
This function will return the json sent to the server in an array format., (*19)
To load the model, use the function:, (*20)
$this->load("model_name")
$model_name is the class name of your model. You should load the model in your controller's constructor. To use the loaded model, you just need to append the model_name to $this->. For example, I loaded the model anothermodel in the constructor $this->load_model("anothermodel"), to access it inside the functions in my controller, I can call $this->anothermodel->getUser() assuming there is a getUser() function inside my model., (*21)
Models are located under /models
Every model MUST extend the SR_Model., (*22)
To make a query to the database, use the function:, (*23)
$this->db->exec("SELECT * FROM tbl_users");
If the SQL statement is a SELECT statement, this function will return an array of the result (which you can directly send as a response in the controller). Else, this will return a bool., (*24)
To UPDATE a row, use the function:, (*25)
$this->db->udapte_record($table, $arrayChanges, "id=condition");
If a record was successfully updated, it will return a success json., (*26)
Routes are the heart and soul of this project. It will determine which class and function will be called., (*27)
The structure of the route should always be, (*28)
class_name/function_name/
You can customize the routes in the config/routes.php folder., (*29)
$route['/about'] = "test";
Here, we are routing /about to execute the get_index() of the Test class., (*30)
$route['/about/name/:param'] = "test/name";
We can also add parameters by putting :param in the place wherein we expect a parameter.
This route will invoke the get_name($a) function of Test class, passing any value in place of the :param to the function., (*31)
$route['about/name/:param/age/:param'] = "test/nameage";
This project also supports multiple parameters. In this example we passed a name and age in that format. By this route, we tell our REST server to invoke the get_nameage($name, $age) method in the Test class. Also, passing the all the parameters., (*32)
Libraries are located under /libraries, (*33)
You should load the needed libraries in the constructor of the controller via the command:, (*34)
$this->load("library_name")
The JWT Library can be used to generate a token., (*35)
To generate a token:, (*36)
$this->jwt->generate_token($user_id, $arrayPayload)
$user_id is the unique identifier of the user.
$arrayPayload is the custom payload you want to add to the token, (*37)
To check if the user passed a VALID json web token to the authorization header:, (*38)
$this->jwt->check()
If it's a valid token, it will return the decoded token and the authorization status ("authorized" or "unauthorized"). Sample response:, (*39)
{
"consumerKey": "YOUR-CONSUMER-KEY",
"userId": 1,
"issuedAt": "11/29/2016 00:47:42 AMNov",
"data": {
"name": "New Name",
"pass": "new_pass"
},
"authorization": "authorized"
}
Since some shared hosting does not read directly from the .htaccess, you may want to enter it manually or ask some help from your hosting provider., (*40)
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change., (*41)
See also the list of contributors who participated in this project., (*42)
This project is licensed under the MIT License - see the LICENSE.md file for details, (*43)
A micro-framework written in PHP that will help you build RESTful APIs.
MIT
framework simplyrest
A micro-framework written in PHP that will help you build RESTful APIs.
MIT