You can route responses inline with ColdBox via the addRoute()
function globally in your main routes.cfm
template or within any Module as well. This will allow you to build simple response functions or even mock out or stub a RESTFul service very easily. The paremeters you will use for response routing will be: response, statusCode and statusText
.
The response
argument can be a string or a closure or UDF pointer. The closure and UDF will receive a rc
argument which represents the request collection parsed already for you. The simple string can also contain replacement strings that are binded to the parsed parameters from the pattern by using {key}
replacements. You can even execute runEvent()
within your closure and delegate to whatever event you want instead of auto-routing as well.
// Simple response routing addRoute( pattern="/users/hello", response="Happy Resting!!Hello From RESTLand
", statusCode=200 ); // Simple response routing with placeholders addRoute( pattern="/users/:username", response="Hello {username} From RESTLand
", statusCode=200 ); // Closure/UDF response routing addRoute( pattern="/users/:username", response=function(rc){ // Do some code here // more code return "Hello #arguments.rc.username# from RESTLand
"; } ); // Closure/UDF response routing with event support addRoute(pattern="/users/:username", response=function(rc){ // Do some code here // more code return runEvent(event='api:users.data', eventArguments={quickData=true}); });
Add Your Comment