Blog

Luis Majano

March 11, 2016

Spread the word


Share your thoughts

In this entry I will go over how to leverage ColdBox's Modular architecture to RESTFul routing. In ColdBox, every module's ModuleConfig.cfc you create has two important facets for building RESTFul services: 1) The this.entryPoint and the 2) routes structure in the configure() method.

If you are creating ColdBox applications using modules, then you will benefit with the capability to nest entry points so they can match to nested sub-modules. Let's say you have the following module structure:

+modules
  + api
    + security
    + data

Then we can create a URL hierarchy to match any sub-module of the api module by leveraging the EntryPoint and the routes configuration.

Parent EntryPoint

The entry point in any module you create will become the pattern argument to a addModuleRoutes() call in the ColdBox routing services. This is important as any rules that apply to URL patterns applies to the entry point, e.g. you can use expressions, nesting, etc.

addModuleRoutes( string pattern, string module, [boolean append='true'] ) 

In the api module our entry point will simple become:

this.entryPoint = "/api";

This means that any incoming URL that has the /api prefix will be routed to the API module.

Parent Routes

The routes structure in the configure() method will be used to declare routes for the module you are building. You can declare all routing inline in this structure or actually declare an array of locations of routing CFM templates to load. By default, every module comes with a single route declared:

routes = [
    { pattern="/:handler/:action?" }
];

In the parent api module you can now register the sub-module entry points so if the parent receives a URL request, the module will then re-direct it to the sub-module:

routes = [
    { pattern="/security", moduleRouting="security" },
    { pattern="/data", moduleRouting="data" }
];

That's it. We have now created sub-module routing by leveraging a URL pattern argument and the moduleRouting argument which dictates to what module to re-direct the routing discovery. This will empower you to create very expressive URL entry points in a modular fashion.

Add Your Comment

Recent Entries

Ortus Content Digest for week of August 12th

Ortus Content Digest for week of August 12th

It's August 12th... what has Ortus been publishing this week? We have the CFML News Podcast, some CFCasts and YouTube Videos, lots of Ortus and ITB Blog Posts. We have a lot more planned for next week as well.

Gavin Pickin
Gavin Pickin
August 12, 2022
Want native Redis Support in Lucee/CFML? Ortus Redis Extension v2.0.0 Released!

Want native Redis Support in Lucee/CFML? Ortus Redis Extension v2.0.0 Released!

We are very excited to bring you another release for our Redis Lucee Extension. This is a major release spawning research of over 9 months. We have done great strides in this new extension to not only bring you the best scaling capabilities via Redis, but also now to introduce to the CFML world: Real-Time messaging with Redis Pub/Sub! Here is our full release notes in our brand new documentation book: What's New With 2.0.0!

Luis Majano
Luis Majano
August 05, 2022