giordanocardillo/slim-restapi

A simple Rest API using Slim Framework


License
MIT

Documentation

Slim RestAPI

Code Climate Codacy Grade Packagist

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