forked from coldbox-modules/relax
/
index.cfm
174 lines (162 loc) · 5.96 KB
/
index.cfm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
<cfoutput>
<!--============================Sidebar============================-->
<div class="sidebar">
<!--- Info Box --->
<div class="small_box">
<div class="header">
<img src="#rc.root#/includes/images/iinfo_icon.png" alt="info" width="24" height="24" />RelaxURL
</div>
<div class="body">
<strong>RelaxURL</strong>, pronounced "Relax-ER", is a utility to help you test against your Relaxed
RESTful service definitions or any other RESTful web service.
</div>
</div>
<!--- Export Box --->
<div class="small_box">
<div class="header">
<img src="#rc.root#/includes/images/export.png" alt="info" width="24" height="24" />Export Lounge
</div>
<div class="body">
<p>You can export your Relaxed Service Documentation in several formats: <br/></p>
<!--- Export COmmands --->
<p class="center">
<!--- html --->
<a href="#event.buildLink(rc.xehExportHTML)#"
target="_blank"
class="button"
title="Export as HTML">
<span>
<img src="#rc.root#/includes/images/html.png" border="0" align="absmiddle" alt="html" />
</span>
</a>
<!--- pdf --->
<a href="#event.buildLink(rc.xehExportPDF)#" class="button"
target="_blank"
title="Export as PDF">
<span>
<img src="#rc.root#/includes/images/pdf.png" border="0" align="absmiddle" alt="html" />
</span>
</a>
<!--- mediawiki --->
<a href="#event.buildLink(rc.xehExportwiki)#" class="button"
target="_blank"
title="Export as MediaWiki">
<span>
<img src="#rc.root#/includes/images/wikipedia.png" border="0" align="absmiddle" alt="html" />
</span>
</a>
<!--- trac --->
<a href="#event.buildLink(rc.xehExporttrac)#" class="button"
target="_blank"
title="Export as TracMarkup">
<span>
<img src="#rc.root#/includes/images/trac.png" border="0" align="absmiddle" alt="html" />
</span>
</a>
</p>
</div>
</div>
<!--- Info Box --->
<div class="small_box">
<div class="header">
<img src="#rc.root#/includes/images/info.png" alt="info" width="24" height="24" />Need Help?
</div>
<div class="body">
<a href="http://www.ortussolutions.com" target="_blank" title="The Gurus behind ColdBox">
<img src="#rc.root#/includes/images/ortus-top-logo.png" alt="Ortus Solutions" border="0" /></a><br/>
<p><strong>Ortus Solutions</strong> is the company behind anything ColdBox. Need professional support, architecture analysis,
code reviews, custom development or anything ColdFusion, ColdBox related?
<a href="mailto:help@ortussolutions.com">Contact us</a>, we are here
to help!</p>
<p class="center">
<a href="javascript:openRemoteModal('#event.buildLink(rc.xehRelaxUpdates)#')" class="button"
title="Check for Updates">
<span>
<img src="#rc.root#/includes/images/download.png" border="0" align="absmiddle" alt="updates" />
Check For Updates
</span>
</a>
</div>
</div>
</div>
<!--End sidebar-->
<!--============================Main Column============================-->
<div class="main_column">
<div class="box">
<div class="header" id="relaxerHeader">
<img src="#rc.root#/includes/images/sofa.png" alt="Database" width="30" height="30" title="Go Relax!" />
Welcome To Relax
</div>
<!--- Body --->
<div class="body">
<p>Welcome to your Relax Console. We have succesfully read the <em>Relax DSL CFC</em>
you configured at <strong>#rc.settings.configCFC#.cfc</strong>. Below is the RESTful
documentation. From here you can also tap into our <strong>RelaxURL</strong> console to test the resources or any web
RESTful service or view our awesome <strong>RelaxLogs</strong> log viewer.
</p>
</div>
<div class="body_vertical_nav clearfix">
<!--- Tab Bar --->
<ul class="vertical_nav">
<li class="active"><a href="##overview">Service Overview</a></li>
<li><a href="##resources">Defined Resources</a></li>
<li><a href="##httpcodes">HTTP Codes</a></li>
<li><a href="##routes">Generated Routes</a></li>
</ul>
<!--- Panes --->
<div class="main_column">
<!-- Content area that wil show the form and stuff -->
<div class="panes_vertical">
<!--- OverView Panel --->
<div>
#renderView("home/docs/serviceOverview")#
</div>
<!--- Resources Panel --->
<div>
#renderView("home/docs/resourceDefinitions")#
</div>
<!--- HTTP Codes Panel --->
<div>
#renderView("home/docs/httpcodes")#
</div>
<!--- Generated Routes --->
<div>
<h1>Generated ColdBox Routes</h1>
<p>The following are the generated ColdBox URL Mapping routes that you can use to
copy and paste into your application.
</p>
<pre class="brush: coldfusion;">
// AutoReload defautls to true since you must be developing, else true for production
setAutoReload( true );
// Sets automatic route extension detection and places the extension in the rc.format variable
setExtensionDetection( #rc.dsl.relax.extensionDetection# );
<cfif rc.dsl.relax.extensionDetection and len(rc.dsl.relax.validExtensions)>
// Setup the list of valid extensions for this application
setValidExtensions('#rc.dsl.relax.validExtensions#');
</cfif>
<cfif rc.dsl.relax.extensionDetection>
// Throw exception 406 when an invalid extension is detected?
setThrowOnInvalidExtension( #rc.dsl.relax.throwOnInvalidExtension# );
</cfif>
// Route Definitions
<cfloop array="#rc.dsl.resources#" index="thisResource">
addRoute(pattern="#thisResource.pattern#"<cfif len(thisResource.handler)>,handler="#thisResource.handler#"</cfif>#flattenActions(thisResource.action)#);
</cfloop>
</pre>
</div>
</div>
</div>
</div>
</div>
</div>
<script language="javascript">
$(document).ready(function() {
// syntax highlight
SyntaxHighlighter.all();
});
function toggleResource(id){
var $div = $("##resource_"+id);
$div.slideToggle();
}
</script>
</cfoutput>