Download the PHP package hq9000/php-rest-router without Composer
On this page you can find all versions of the php package hq9000/php-rest-router. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download hq9000/php-rest-router
More information about hq9000/php-rest-router
Files in hq9000/php-rest-router
Package php-rest-router
Short Description A framework for building REST API structures
License
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 php-rest-router
PHP REST router
A simple opinionated PHP framework for building API structures.
Motivation
In one of the proprietary projects I was working on, we needed to have a huge and complex REST api surface. Due to its dynamic nature and deep branching, it was considered suboptimal to go the normal "method per action" way.
What was needed is to be able to define a certain meta-structure and have the endpoints be just as a reflection of it.
Main concepts
The main concepts of the framework are the ones of:
- a structure (a tree of nodes)
- node traversing
Structure (a tree of nodes)
A Structure is represented by hq9000\PhpRestRouter\Structure class.
Structure is a unidirectional, acyclic graph of Nodes.
Each node, except the root one, has exactly one input node.
note: the arrows on the diagram above rather show the direction of the traversing, and not the direction of association.
Also, every node has associated:
- path processor - something that is responsible for gathering a piece of information relevant to this node
- path trigger - something that will make node traversing choose this node instead of its sibling.
- if a node is the only output of its upstream node, the trigger can be omitted
Node traversing
The useful thing a structure makes possible is ability to traverse it.
Traversing is done by calling its public function trace($path, &$dataAccumulator),
where:
pathis a string representing an API endpointdataAccumulatoris a passed-by-reference array that will be used bypath processorsto put information extracted from the path at each visited node.
The ultimate goal of traversing is to come up with two things:
- the final node
- the fully populated accumulator array
the user of the framework may want to associate certain logic with these bits of information, but this is intentionally left out of scope of the framework.
Usage Example
This chapter gives a bit of human-readable explanation to complement reading the source code of CommonTest.php.
In that test, we pretend that the useful thing nodes can do is to hold certain tags.
For that, we extend the Node class by DomainNode:
The structure of these nodes is shown on the simplified diagram below:
The test itself performs the "tracings" and checks their results, for example that class2/123123 results in the $idNode found as the final one and the data array appropriatelly populated with
