sowl-rest-api

REST API demo for scholarshipowl.com

Setup

composer update && composer install

Dependencies

• PHP 7
• composer
• slim
• Toast
• MySQL
• chadicus/slim-oauth2
• RedBean

Testing

vendor/bin/toast

Usage

/api/scholarships returns all scholarships within the MySQL database in JSON format.
/api/scholarships/{id} returns scholarship with {id} in JSON format.

Project Structure

• public/index.php entry point of the API.
• public/auth.php OAuth 2.0 endpoint.
• test/ unit tests.
• src/config.php application settings. Check this file before running.
• src/config_auth.php special config for OAuth 2.0. Can be same as src/config.php Check this file before running.
• src/db.php database connection.
• routes/ OOP representation of end-points.
• misc/sample_data.php sample data generator.
• misc/oauth2.sql OAuth table generator.
• models/Scholarship.php OOP representation of a Scholarship.