{"id":28839498,"url":"https://github.com/coldbox-modules/relax","last_synced_at":"2026-02-02T14:32:02.217Z","repository":{"id":1196710,"uuid":"1103377","full_name":"coldbox-modules/relax","owner":"coldbox-modules","description":"Relax is a set of tools for modeling, documenting and testing RESTFul APIs","archived":false,"fork":false,"pushed_at":"2025-03-10T22:20:30.000Z","size":22873,"stargazers_count":13,"open_issues_count":10,"forks_count":19,"subscribers_count":5,"default_branch":"development","last_synced_at":"2026-01-15T07:33:19.795Z","etag":null,"topics":["modules","mvc","mvc-application","rest","rest-api","restful","restful-api"],"latest_commit_sha":null,"homepage":"https://coldbox-relax.ortusbooks.com","language":"ColdFusion","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coldbox-modules.png","metadata":{"files":{"readme":"readme.md","changelog":"changelog.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2010-11-22T19:56:12.000Z","updated_at":"2025-12-08T18:42:46.000Z","dependencies_parsed_at":"2025-01-14T20:37:17.527Z","dependency_job_id":"0a68b886-3f94-4a09-82ee-10b7744258b9","html_url":"https://github.com/coldbox-modules/relax","commit_stats":null,"previous_names":["coldbox/coldbox-relax"],"tags_count":21,"template":false,"template_full_name":null,"purl":"pkg:github/coldbox-modules/relax","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldbox-modules%2Frelax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldbox-modules%2Frelax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldbox-modules%2Frelax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldbox-modules%2Frelax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coldbox-modules","download_url":"https://codeload.github.com/coldbox-modules/relax/tar.gz/refs/heads/development","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coldbox-modules%2Frelax/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29013023,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-02T12:48:30.580Z","status":"ssl_error","status_checked_at":"2026-02-02T12:46:38.384Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["modules","mvc","mvc-application","rest","rest-api","restful","restful-api"],"created_at":"2025-06-19T14:41:36.889Z","updated_at":"2026-02-02T14:32:02.211Z","avatar_url":"https://github.com/coldbox-modules.png","language":"ColdFusion","readme":"[![Build Status](https://travis-ci.org/coldbox-modules/relax.svg?branch=development)](https://travis-ci.org/coldbox-modules/relax)\n\n# WELCOME TO COLDBOX RELAX\n\n\u003eRELAX = RESTFul Tools For Lazy Experts!\n\nWhat is Relax? ColdBox Relax is a set of RESTFul tools for lazy experts. We pride ourselves in helping you (the developer) work smarter and \nColdBox Relax is a tool to help you document your projects faster. ColdBox Relax provides you with the necessary tools to \nautomagically model, document and test your RESTFul services. One can think of ColdBox Relax as a way to describe RESTFul web services, \ntest RESTFul web services, monitor RESTFul web services and document RESTFul web services–all while you relax!\n\n## LICENSE\n\nApache License, Version 2.0.\n\n## IMPORTANT LINKS\n\n- Code: https://github.com/coldbox/relax\n- Issues: https://ortussolutions.atlassian.net/projects/RELAX/issues\n- Documentation: https://relax.ortusbooks.com\n\n## SYSTEM REQUIREMENTS\n\n- Lucee 5+\n- ColdFusion 2016+\n\n## INSTRUCTIONS\n\nUse CommandBox to install:\n\n`box install relax`\n\n## Settings\n\nYou will need to update the your `ColdBox.cfc` with a `relax` structure under the `moduleSettings` struct with your preferred settings for Relax.  \n \n```js\nmoduleSettings = {\n\trelax = {\n\t\t// The location of the relaxed APIs, defaults to models.resources\n\t\tAPILocation = \"modules.relax.models.resources\",\n\t\t// Default API to load, name of the directory inside of resources\n\t\tdefaultAPI = \"myapi\",\n\t\t// APIs to be excluded from display - may be a list or an array and items may include Regex\n\t\texclude         = \"\",\n\t\t// History stack size, the number of history items to retain in the Relaxer test tool\n\t\tmaxHistory = 10\n\t}\n};\n```\n\n## Modeling\n\nYou 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.\n\n\n********************************************************************************\nCopyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp\nwww.coldbox.org | www.luismajano.com | www.ortussolutions.com\n********************************************************************************\n\n### HONOR GOES TO GOD ABOVE ALL\n\nBecause of His grace, this project exists. If you don't like this, then don't read it, its not for you.\n\n\u003e\"Therefore being justified by faith, we have peace with God through our Lord Jesus Christ:\nBy whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God.\nAnd not only so, but we glory in tribulations also: knowing that tribulation worketh patience;\nAnd patience, experience; and experience, hope:\nAnd hope maketh not ashamed; because the love of God is shed abroad in our hearts by the \nHoly Ghost which is given unto us. .\" Romans 5:5\n\n### THE DAILY BREAD\n\n \u003e \"I am the way, and the truth, and the life; no one comes to the Father, but by me (JESUS)\" Jn 14:1-12\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldbox-modules%2Frelax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoldbox-modules%2Frelax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoldbox-modules%2Frelax/lists"}