Relax is a set of tools for modeling, documenting and testing RESTFul APIs
JavaScript HTML CSS ColdFusion
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
apidocs finalized new build process Feb 18, 2016
config change modules autoReload to false Mar 23, 2016
handlers RELAX-2 Feb 14, 2015
includes path updates to allow for deep nesting of modules Sep 26, 2016
layouts RELAX-2 Feb 14, 2015
modules/relax
tests
views/main
workbench
.gitattributes
.gitignore ignore build-generated directories Sep 27, 2016
.travis.yml attempt to fix build error Sep 15, 2016
Application.cfc test updates to handle travis build tests on nested path Sep 15, 2016
Developer.md add Developer.md file to clarify development conventions Mar 23, 2016
Gruntfile.js updates for displays of response samples Mar 18, 2016
LICENSE Update box.json and readme with new locations #36 resolve Aug 5, 2015
bower.json
box.json Update box.json Oct 26, 2016
index.cfm
package.json refactor JS and css to use Grunt Feb 15, 2016
readme.md Update readme.md May 9, 2016
require.build.js
server-relax-cf10.json ACF Compatibility updates Sep 15, 2016
server-relax-cf11.json ACF Compatibility updates Sep 15, 2016
server-relax-cf2016.json ACF Compatibility updates Sep 15, 2016
server-relax-lucee5.json ACF Compatibility updates Sep 15, 2016
server.json Implements the ability to translate RelaxDSL in to OpenAPI format Feb 29, 2016

readme.md

Build Status

WELCOME TO COLDBOX RELAX

RELAX = RESTFul Tools For Lazy Experts!

What is Relax? ColdBox Relax is a set of RESTFul tools for lazy experts. We pride ourselves in helping you (the developer) work smarter and ColdBox Relax is a tool to help you document your projects faster. ColdBox Relax provides you with the necessary tools to automagically model, document and test your RESTFul services. One can think of ColdBox Relax as a way to describe RESTFul web services, test RESTFul web services, monitor RESTFul web services and document RESTFul web services–all while you relax!

LICENSE

Apache License, Version 2.0.

IMPORTANT LINKS

SYSTEM REQUIREMENTS

  • Lucee 4.5+
  • Railo 4+
  • ColdFusion 9+

INSTRUCTIONS

Just drop into your modules folder or use the box-cli to install

box install relax

Settings

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

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",
    // History stack size, the number of history items to track in the RelaxURL
    maxHistory = 10
};

Modeling

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.


Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.coldbox.org | www.luismajano.com | www.ortussolutions.com


HONOR GOES TO GOD ABOVE ALL

Because of His grace, this project exists. If you don't like this, then don't read it, its not for you.

"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God. And not only so, but we glory in tribulations also: knowing that tribulation worketh patience; And patience, experience; and experience, hope: And hope maketh not ashamed; because the love of God is shed abroad in our hearts by the Holy Ghost which is given unto us. ." Romans 5:5

THE DAILY BREAD

"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)" Jn 14:1-12