giordanocardillo/slim-restapi

A simple Rest API using Slim Framework

1.0.12 2018-04-28 13:25 UTC

Requires

• php: >=5.5.0
• firebase/php-jwt: ^5.0
• monolog/monolog: ^1.23
• slim/slim: ^3.0

Requires (Dev)

• phpmd/phpmd: ^2.6

MIT

• Giordano Cardillo

README

A RESTful API based on Slim Framework using exception driven coding.

Directory Structure

+-- app                Contains app files
|  +-- RestAPI         Contains core files
|  |  +-- Exceptions   Contains custom exception classes
|  |  +-- Utils        Contains utilities
|  +-- routes          Contains the routes
|  +-- config.json     Configuration file
+-- public_html        Public web folder
|  +-- index.php       Main slim page
+-- database.sql        The database structure file   

How to configure it

To configure the RestAPI there is a config.json file inside the app folder. It is self-explanatory.

How to use it

This project uses composer, so you can just issue

composer create-project giordanocardillo/slim-restapi .

Then import the DB using the provided database.sql file

User authentication workflow

TODO