maxcarter/restup

A customizable Representational State Transfer (REST) Application Program Interface (API) designed to provide a quick set of tools for developers to quickly build their own API.

REST-UP

A customizable Representational State Transfer (REST) Application Program Interface (API) designed to provide a quick set of tools for developers to quickly build their own API., _(*1)

Note: this repository is currently under construction., _(*2)

Features

• Supports basic CRUD (Create Read Update Delete) operations
• Supports HTTP requests GET POST PUT and DELETE
• Can interact with anything that can send an HTTP request
• Data is returned in JSON (JavaScript Object Notation) format
• MySQL database preset
• Protection against MySQL injection
• Interfacing with new tables is as simple as adding new models
• Customizable controllers to interface with other databases

Installation

REST-UP can be installed using composer:, _(*3)

composer require maxcarter/restup

OR by simply extracting all files to the desired location in your website directory:, _(*4)

git clone https://github.com/maxcarter/REST-UP.git
rsync -r REST-UP/* Path/To/Destination

Test

Once installed you should be able to see the welcome text at: http://YourDomain.com/PathToAPI, _(*5)

Another way to test the API is to install the Chrome Extension Postman then open the app and send http requests to http://YourDomain.com/PathToAPI., _(*6)

Server Requirements

• PHP v5.6+
• MySQL v5.6+

MySQL Schema

The sample code is based on the following MySQL table:, _(*7)

CREATE TABLE `person` (
  `id` int NOT NULL AUTO_INCREMENT,
  `Name` varchar(255) DEFAULT NULL,
  `City` varchar(255) DEFAULT NULL,
  `Email` varchar(255) DEFAULT NULL
);

To insert sample data into this database:, _(*8)

INSERT INTO `person` (`Name`, `City`, `Email`) VALUES
('Clark Kent', 'Smallville', 'superman@justiceleague.com');

Configuration

To configure this REST-API to work with your database follow these steps:, _(*9)

1. Modify config.php with the appropriate credentials.
2. Create your own DTO (Data Transfer Object) and place it in the models directory. (see models/person.php for a sample DTO)

Customize

This REST API can be customized to work with different databases. The default preset is MySQL, however, you can create your own database controller to interface with different databases and implement custom functionality., _(*10)

To create a custom controller follow these steps:, _(*11)

1. Create a new PHP file to implement the Controller class (see controllers/mysql.php for an example)
2. Ensure your class implements the required CRUD functions.
3. Modify config.php to include your controller's file name and database credentials.

Required Functions

/**
 * Create a new entry
 * @param [object] - The entry to be inserted
 * @return [object] - JSON result of insertion
 */
postValue($data);

/**
 * Read all entries
 * @return [array] - An array of objects 
 */
getValues();

/**
 * Read a single entry
 * @param [int] - The unique id of the entry
 * @return [object] - The requested entry
 */
getValue($value);

/**
 * Update an entry
 * @param [object] - The entry to be updated
 * @return [object] - JSON result of update
 */
putValue($data);

/**
 * Delete a single entry
 * @param [int] - The unique id of the entry
 * @return [object] - JSON result of deletion
 */
deleteValue($value);

Future Updates

• Live Demo
• HTTP request documentation
• More database presets