H+C Rest Routes

Introduction A plugin for custom API routing. Made with love by Howatson+Co. Usage There are two parts to using this plugin: 1. Defining API routes 2. Defining custom controllers for handling response logic To do either of these, you will need to first access the Rest API Server class instance. This can be achieved either by calling the global scope function HCRR like this: Or, by accessing the global scope variable assigned: Defining Routes You can define a route through the registerRoute method attached to the Router class, like so: The registerRoute method takes three arguments: - API URI pattern to be matched for this route to be executed. This can be a regex string. - Name of Controller to instantiate. - Name of method attached to Controller to execute. Defining Controllers When defining Controllers, adhere to the following rules: - The controller must extend \HC\RestRoutes\Abstracts\ControllerAbstract - Controller methods should be named ${name}${httpVerb}, where: - name is the name you pass to the route, and - httpVerb is the HTTP verb of the request (e.g GET, POST, PUT, etc) - Return the data you want to respond with. - Throw a RestfulException provided by the