Blog

ColdBox Relax v3.0 Released

Jon Clausen April 11, 2017

Spread the word

Jon Clausen

April 11, 2017

Spread the word


Share your thoughts

Coldbox Relax LogoColdBox Relax Moldule v3.0 has been officially released, which includes native support for the OpenAPI/Swagger specification, in addition to a variety of feature upgrades and enhancements.

Version 3.0 makes the OpenAPI/Swagger specification the default documentation format for describing your APIs, while deprecating the Relax programmatic DSL ( scheduled EOL is v4.0 ). In addition, the release includes a complete overhaul of the user interface and Relax API Test Tool, to provide users with a seamless experience for documenting, viewing, testing and exporting in a variety of formats.

The OpenAPI specification offers a convenient and portable way to describe your API, its requirements, parameters, and data conventions. You may also choose to use this to describe your API in the form of HTTP OPTIONS responses to fulfill CORS requirements or to allow rich hypermedia documentation for your consumers.

What can you do with Relax?

  • Define your ReSTful services via the OpenAPI/Swagger JSON syntax
  • Use the "Relaxer" API Test tool to test your RESTful web service enpoints
  • Use the "Relaxer" API Test too to test against ANY RESTful service
  • Keep a history of your latest Relaxed test requests so you can rebuild your request and test again
  • Programmatic DSL for configuration of your RESTful services (Deprecated as of v2.3)

Relax also allows you to import an OpenAPI/Swagger JSON specification in to your defined apiResources directory, export normalized schema (JSON) for other services and also four export formats:

  • HTML
  • PDF
  • WikiText
  • TRAC Format

Markdown export is also planned for an upcoming minor release.

By convention, Relax looks for supported formats in the following order (note that the top-level file shares the name of the parent directory):

  1. myResourceDirectory/myapi/myapi.json - JSON OpenAPI schema
  2. myResourceDirectory/myapi/myapi.yaml - YAML OpenAPI schema
  3. myResourceDirectory/myapi/Relax.cfc - Relax programmatic DSL (deprecated)

To install Relax, use CommandBox:

box install relax

Relax comes with three example API's which are configured by default:

  • Swagger Petstore - The swagger Petstore API example, which is described using the OpenAPI/Swagger specification
  • Forgebox API - Version 2 of the Forgebox API, which is described through the, now-deprecated, RelaxDSL specification.
  • MyAPI - Another example, using the RelaxDSL specification.

Both Forgebox and MyAPI may be exported from within the interface in to a normalized Swagger JSON schema, while the Petstore example provides and complete example of using a nested file structure to contain different parts of your API documentation.

If you'd like to play with Relax, here are a few lines of script, which will create an app skeleton, install the module, and start a server. Simply navigate to the /relax path, once your browser opens, to view the new changes.

mkdir relaxtest && cd relaxtest
box coldbox create app name=relaxTest
box install relax
box server start --rewritesEnable

or from within the CommandBox shell:

mkdir relaxtest --cd
coldbox create app name=relaxTest
install relax
server start --rewritesEnable

For additional information on relax, including installation and advanced configuration, view the official documentation here.

Add Your Comment

Recent Entries

Into the Box - Updates as of June 27th, 2022

Into the Box - Updates as of June 27th, 2022

Into the Box Super Early Bird ticket pricing is over, but you can still get the Early Bird. Last week we had more episodes of the Modernize or Die Podcast - Conference Edition for ITB 2022 and announced the first 2 groups of Pre-Conference Track for Into the Box.

Gavin Pickin
Gavin Pickin
June 27, 2022
Ortus Content Digest for week of June 24th

Ortus Content Digest for week of June 24th

What has Ortus been publishing this week? We have the CFML News Podcast, more ITB Workshop Podcasts, 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
June 24, 2022
Online CF Meeting Series on Code Reuse, 3rd Party Libraries and Package Management

Online CF Meeting Series on Code Reuse, 3rd Party Libraries and Package Management

Gavin has presented several webinars on the Online ColdFusion Meetup with Charlie Arehart. This series was inspired by many questions from customers and community members, wanting to learn more about code reuse, when should they write their own modules, when should they use java or coldfusion/cfml packages, and why should people use CommandBox and ForgeBox vs manually handling your 3rd party and shared libraries. This series tries to go back to basics, and explain pros and cons of each approach, hopefully shedding light and demystifying 3rd party libraries, package management, CommandBox endpoint installations, and ForgeBox being the home of all CFML, not a tool for box only products and tools. Check out this blog post for all of these sessions, and links on how to view them on YouTube.

Gavin Pickin
Gavin Pickin
June 23, 2022