Download the PHP package hc/rest-routes without Composer
On this page you can find all versions of the php package hc/rest-routes. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package rest-routes
Introduction
A plugin for custom API routing. Made with love by Howatson+Co.
Usage
There are two parts to using this plugin:
- Defining API routes
- 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:nameis the name you pass to the route, andhttpVerbis the HTTP verb of the request (e.gGET,POST,PUT, etc)
Returnthe data you want to respond with.- Throw a
RestfulExceptionprovided by theRestRoutesplugin to handle exceptions.
See example below:
Next, we will need to register the controller.
To register the Controller, use the ControllerFactory class register method:
Full example
Bringing it all together, an example could look like this:
Extra
Authorisation
To ensure an endpoint only gives the full payload to a user who is authorised, you can use the validateAdmin and validateEditor methods which are attached to the \HC\RestRoutes\Abstracts\ControllerAbstract class.
Defining API prefix
The default API prefix is /api/hcrr. You can customise this by using the setPrefix method on the \HC\RestRoutes\Router class:
