iopa-router
About
iopa-router
is lightweight router for the IOPA framework
It routes HTTP, COAP and MQTT requests, with simple uri templates and parameter/query string parsing.
Usage
Installation:
npm install iopa-router
Hello World
const Router =iopa =http =iopaConnect =var app = ;app;app;app;http;
Methods
route.get
: MatchGET
requestsroute.post
: MatchPOST
requestsroute.put
: MatchPUT
requestsroute.head
: MatchHEAD
requestsroute.del
: MatchDELETE
requestsroute.options
: MatchOPTIONS
requestsroute.all
: Match all above request methods.route.debugget
: MatchGET
forscheme='debug'
requests
API
If you want to grab a part of the path you can use capture groups in the pattern:
route
Query paramaters in the url are also added to owin.Params
:
route;
The capture patterns matches until the next /
or character present after the group
route;
Optional patterns are supported by adding a ?
at the end
route;
If you want to just match everything you can use a wildcard *
which works like posix wildcards
route;
If the standard capture groups aren't expressive enough for you can specify an optional inline regex
route;
You can also use regular expressions and the related capture groups instead:
route;
Error handling
By default iopa-router will simply move to next iopa middleware function if no route matched.
The router is a Promise/A compatible async function that respects error bubbling, but has no specific handling built in.
You can provide a catch-all to a given route that is called if no route was matched:
route.get(function(context) {
// called if no other get route matched
context.response.writeHead(404);
context.response.end('no GET handler found');
});
Credits
This router was ported from gett/router which was developed under MIT license by Mathias Buus Madsen and Ian Jorgensen.
It has been developed to be a core component of the IOPA ecosystem.