Relax 4.1.0 Released

Jon Clausen May 07, 2020

Spread the word

Jon Clausen

May 07, 2020

Spread the word

Share your thoughts

We are so excited to bring you the release of Relax version 4.1.0 for Coldbox. Though the release version is minor, this version contains a number of enhancements to OpenAPI v3 support, including better formatting and display of the new-to-3.0 requestBody schema and properties. In addition the user experience has been greatly improved as the UI has been rewritten in VueJS and is now optimized for displaying large API documents with hundreds of routes and thousands of methods. Enjoy!

Relax v4.1.0


  • Converts the UI from a BackboneJS implementation to VueJS
  • Performance improvements in rendering large APIs
  • Theme and nested objects updated for better meta/list rendering and display


  • Adds additional support for OpenAPI v3 schema definitions ( content, items )
  • Adds auto-generation of examples from schema from examples defined within items/properties, when not explicitly provided
  • Adds a module setting to exclude APIs from display listings


  • Removes the direct export of PDF documents due to lack of HTML5 support w/in CFDocument. Export button now routes to HTML after providing PDF print instructions
  • Additional OpenAPI v3.x support

System Requirements

  • Lucee 5+
  • ColdFusion 2016+


Use CommandBox to install:

box install relax


You will need to add ColdBox.cfc with a relax structure under the moduleSettings struct with your preferred settings for Relax.

moduleSettings = {
	relax = {
		// The location of the relaxed APIs, defaults to models.resources
		APILocation = "modules.relax.models.resources",
		// Default API to load, name of the directory inside of resources
		defaultAPI = "myapi",
		// APIs to be excluded from display - may be a list or an array and items may include Regex
		exclude         = "",
		// History stack size, the number of history items to retain in the Relaxer test tool
		maxHistory = 10


You can look at the samples inside of this module under the models/resources directory. To start you can copy the Relax.cfc into your own project folder and then start spicing up the API via the RelaxDSL methods.

Add Your Comment

Recent Entries

Ortus Will be at Adobe CF Summit 2022!

Ortus Will be at Adobe CF Summit 2022!

4 of our Ortusians will be speaking at CF Summit this year from Oct 3 - 4 in Las Vegas, Nevada. Here are all the details you need to join us and enjoy valuable CFML content to modernize your projects! We are sponsoring the event and will have a booth for you to come by and have a chat with our team!

Maria Jose Herrera
Maria Jose Herrera
September 27, 2022
Prefetching in CBWIRE

Prefetching in CBWIRE

When I want to increase the perceived speed of my CBWIRE apps, one tool I reach for is prefetching. Prefetching is a built-in feature of Livewire JS that allows you to invoke an Action's results on mouseOver.

Grant Copley
Grant Copley
September 20, 2022
Into the Box 2022 - Conference Recap

Into the Box 2022 - Conference Recap

This years Into the Box has just wrapped up, but we are already preparing for 2023’s Into the Box, May, Houston Texas! The event was a huge success, we had solid attendance in person, and almost doubled our online viewership from 2021, great feedback from attendees in Houston, and online. So many attendees didn’t say goodbye at the end of the conference, they said see you next year, which, as an organizer lets you know you’ve done things right, and the hard work has paid off.

Gavin Pickin
Gavin Pickin
September 16, 2022