Edit

Installation

Use CommandBox to install

box install relax

Or, to install the bleeding-edge version

box install relax@be

System Requirements

  • Lucee 4.5+

  • Railo 4+

  • ColdFusion 9+

Settings

You will need to update the your ColdBox.cfc with a relax structure with your preferred settings for Relax.

// Relax Configuration Settings
relax = {
    // The location of the relaxed APIs, defaults to models.resources
    APILocation = "models.resources",
    // Default API to load, name of the directory inside of resources
    defaultAPI = "forgebox",
    // Whether to cache the API Service as a singleton - In development/authoring, you'll want this set to false
    cache = false
};

Modeling

You can look at the samples inside of the relax module under the models/resources directory.

You may also open up the Relax ui and click the "Export" button on the sidebar to export an example JSON schema which may be customized and then imported back in to Relax.

For reference, the the contents of that export, at the present, would be:

PreviousChangelogNextGetting Started

Last updated