After installing module using composer, you need to follow steps below:
- Add content of src/.htaccess to your .htaccess file or just copy it to your root directory if u don't have one
- Create basic folder for your API (by default it should be named 'Api')
- Create application folder inside your Api (by default it should be named 'App')
- Create Routing.php file where you put your routing config with basic structure as defined below:
- Implement 'show' method in your basic controller which will be called by default if no other method is passed
- Create index.php file with code as presented below
- To call default method in your basic controller type yoursitename.com/api/ (for external api) or yoursitename.com/internal_api/ (for internal api)
- To call method 'test' in your custom controller for internal api type yoursitename.com/api/custom_route/test
File: index.php
// Register vendor autoloader
require_once '../vendor/autoload.php';
// Start application
session_start();
Framework::detectContext($_GET['API_TYPE']);
Framework::translateUrl($_GET['URL']);
Framework::run();
File: Routing.php
$FRAMEWORK_ROUTING = array(
Framework::API_TYPE_EXTERNAL => array(
Framework::DEFAULT_CONTROLLER_ROUTE_NAME => 'Api\App\Basic\Controller\BasicControllerName',
'custom_route' => 'Api\App\Path\To\Your\Controller',
),
Framework::API_TYPE_INTERNAL => array(
Framework::DEFAULT_CONTROLLER_ROUTE_NAME => 'Api\App\Basic\Controller\BasicControllerName',
),
);