php-multiformat-api

php api that handles json or html responses depending by the request;

logic

1. client uses 'Accept' tag in headers during request and 'Authorization' for the token (implemented firebase\php-jwt package). Tokens are parsed in place and do not require a database table;
2. php api can handle html or json response format;
3. requests are REST-based and routes are all in the singular form, like the corresponding class. If client calls GET api/product, the backend search for -> (ex. Product->get()). In case of html rendered request backend automatically searches for web/_.php (ex. web/get_product.php) file containing view content. Route names are always in singular form;
4. Database class can handle all crud queries and also a 'procedure' method for stored procedure calls;

classes

'core' directory contains all the classes used by the system; 'local' can contains all custom classer not to be used as routes; 'routes' containes all the entities corresponsing to api's URIs. Routes classes must extend Api\Core\RouterModel abstract class;

use

1. composer install
2. a config.php file created by composer after 'install' command. just compile fields inside the file;
3. Routes classes must extend Api\Core\RouterModel abstract class. You can go to 'script' directory and call createRoute.php script to automatically create new routes with specified name, than implement them;
4. stored procedure parameters for mysal database need to be passed in same order as the defined procedure;

frontend

index.html is only a single page test file;

todos

1. project is still in progress;
2. createRoute.php script called by composer run-script createroute command does not function
3. create an error's handler method;

credits

implemented use of jwt tokens from firebase/php-jwt repository (forked from the original luciferous/jwt repository);

license

3-Clause BSD;