We're excited to announce the first stable release of bx-compat-rest, the official CFML REST compatibility module for the BoxLang web runtime. This release means that existing ACF and Lucee users, whose applications rely on CFML REST implemenations can now run on BoxLang. With bx-compat-rest, that same familiar model works natively inside BoxLang's modern JVM web runtimes.
What's Included in v1.0.0
- Automatic service discovery and registration — Drop your REST-annotated CFCs in a directory and call
restInitApplication()to get going - or configure your REST application paths in your configuration. The module scans, registers, and routes requests automatically. - Intelligent path routing — Full support for dynamic path parameters, query strings, and HTTP method matching across GET, POST, PUT, PATCH, DELETE, HEAD, and OPTIONS.
- Content negotiation — Automatic serialization and deserialization based on
AcceptandContent-Typeheaders, supporting JSON and XML out of the box. - CORS preflight support — Built-in handling of OPTIONS requests with configurable allowed methods and headers. CORS policies can also be configured at the module level
- CF-compatible BIFs —
restInitApplication,restDeleteApplication, andrestSetResponseare all available just as they were in Adobe ColdFusion and Lucee. We also introduce arestGetServiceMapbuilt-in-function to allow you to inspect all registered REST applications and routes in the runtime.
Whether you're migrating a legacy CFML API or building something new, bx-compat-rest gives BoxLang web applications a first-class REST foundation.
Install it today via CommandBox:
install bx-compat-rest
This module is part of our premium modules included in our professional subscriptions. For more information on module installation and configuration, see the official documentation
Add Your Comment