-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.html
453 lines (434 loc) · 13.2 KB
/
docs.html
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>React - Bootstrap Theme</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<!-- stylesheets -->
<link rel="stylesheet" type="text/css" href="css/compiled/theme.css">
<link rel="stylesheet" type="text/css" href="css/vendor/animate.css">
<link rel="stylesheet" type="text/css" href="http://yandex.st/highlightjs/8.0/styles/default.min.css">
<!-- javascript -->
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
<script src="js/bootstrap/bootstrap.min.js"></script>
<script src="js/theme.js"></script>
<script src="http://yandex.st/highlightjs/8.0/highlight.min.js"></script>
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
</head>
<body id="docs" data-spy="scroll" data-target="#guide">
<div id="guide">
<h1 class="logo">
<a href="index.html">React</a>
</h1>
<ul class="menu nav">
<li>
<a href="#intro">Introduction</a>
</li>
<li>
<a href="#auth">Authentication</a>
</li>
<li>
<a href="#games">Games</a>
<ul class="nav">
<li><a href="#js-individual-compiled">Retrieve a Game</a></li>
<li><a href="#js-data-attrs">Create a Game</a></li>
<li><a href="#js-programmatic-api">Delete a Game</a></li>
</ul>
</li>
<li>
<a href="#users">Users</a>
<ul class="nav">
<li><a href="#users">Retrieve a User</a></li>
<li><a href="#users">Create a User</a></li>
<li><a href="#users">Delete a User</a></li>
</ul>
</li>
<li>
<a href="#orders">Orders</a>
</li>
<li>
<a href="#errors">Errors</a>
</li>
</ul>
</div>
<div id="api-docs">
<div id="methods">
<div class="languages">
<a class="language selected" data-lang="ruby" href="#">Ruby</a>
<a class="language" data-lang="python" href="#">Python</a>
<a class="language" data-lang="php" href="#">PHP</a>
</div>
<div class="method" id="intro">
<div class="method-section clearfix">
<div class="method-description">
<h3>Introduction</h3>
<p>
This is a documentation page demo for <a href="http://en.wikipedia.org/wiki/Application_programming_interface">an API</a>, you can use it for your own purposes if you want to showcase your API or some other kind of documentation for your app.
The info shown here is merely for the demo so it is not real.
</p>
<p>
You can edit the code with anything you like and use only the languages that you want, the code syntax highlighting is made using
<a href="http://highlightjs.org" target="_blank">highlightjs.org</a> and supports a good
variety of languages. Comes with some color schemes by default but you can easily customize the scheme of each language directly from the CSS.
</p>
</div>
<div class="method-example">
<pre>
<code class="ruby"># All this code is just for demonstration purposes
React.api_key = "In here goes your api key!"</code><code class="python"># All this code is just for demonstration purposes
react.api_key = "In here goes your api key!"</code><code class="php"># All this code is just for demonstration purposes
React::setApiKey("In here goes your api key!");</code>
</pre>
</div>
</div>
</div>
<div class="method" id="auth">
<div class="method-section clearfix">
<div class="method-description">
<h3>Authentication</h3>
<p>
It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
</p>
</div>
<div class="method-example">
<pre>
<code class="ruby">class A < B
def self.create(object = User)
return object
end
def full_name
return "#{self.first_name} #{self.last_name}"
end
end
</code><code class="python">class Mapping:
def __init__(self, iterable):
self.items_list = []
self.__update(iterable)
def update(self, iterable):
for item in iterable:
self.items_list.append(item)
</code><code class="php">class myClass {
var $input;
var $output;
function myClass($input) {
$output = 'You entered: ' . $input;
return $output;
}
}
</code>
</pre>
</div>
</div>
</div>
<div class="method" id="games">
<div class="method-section clearfix">
<div class="method-description">
<h3>Games</h3>
<p>
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
</p>
<p>
It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
</p>
<div class="info">
<h4>The Game Object</h4>
<div class="field clearfix">
<div class="key">name:</div>
<div class="desc">
<strong>string</strong>
The name of the game
</div>
</div>
<div class="field clearfix">
<div class="key">company:</div>
<div class="desc">
<strong>string</strong>
The name of the company creator
</div>
</div>
<div class="field clearfix">
<div class="key">some_key:</div>
<div class="desc">
<strong>string</strong>
</div>
</div>
<div class="field clearfix">
<div class="key">rating:</div>
<div class="desc">
<strong>integer</strong>
The rating of the game from 0 to 100.
</div>
</div>
<div class="field clearfix">
<div class="key">description:</div>
<div class="desc">
<strong>hash</strong>
key/value pairs with fields that describe the game.
</div>
</div>
</div>
</div>
<div class="method-example">
<pre>
<code class="ruby">React::Game.create(
:name => "Super Mario Bros",
:company => "Nintendo",
:some_key => "yey_JA390094AWPIWWN435",
:rating => 100
)
</code><code class="python">react.Game.create(
name="Super Mario Bros",
company="Nintendo",
some_key="yey_JA390094AWPIWWN435"
rating=100
)
</code><code class="php">React_Charge::create(array(
"name" => "Super Mario Bros",
"company" => "Nintendo",
"some_key" => "yey_JA390094AWPIWWN435"
"rating" => 100
));
</code>
<code class="ruby always-visible"># Object Response
{
"object": "Game",
"name": "Super Mario Bros",
"company": "Nintendo",
"some_key": "yey_JA390094AWPIWWN435",
"rating": 100
"description": {
"some_desc1": null,
"some_desc2": null,
"some_desc3": null,
"some_desc4": null,
}
"valid": true,
"other_field": null
}
</code>
</pre>
</div>
</div>
</div>
<div class="method" id="users">
<div class="method-section clearfix">
<div class="method-description">
<h3>Users</h3>
<p>
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
</p>
<div class="info">
<h4>The User Object</h4>
<div class="field clearfix">
<div class="key">name:</div>
<div class="desc">
<strong>string</strong>
The name of the user
</div>
</div>
<div class="field clearfix">
<div class="key">email:</div>
<div class="desc">
<strong>string</strong>
The email of the user
</div>
</div>
<div class="field clearfix">
<div class="key">country:</div>
<div class="desc">
<strong>string</strong>
2 letter code for the country
</div>
</div>
<div class="field clearfix">
<div class="key">age:</div>
<div class="desc">
<strong>integer</strong>
Age of the user
</div>
</div>
<div class="field clearfix">
<div class="key">description:</div>
<div class="desc">
<strong>hash</strong>
key/value pairs with fields that describe the user.
</div>
</div>
</div>
</div>
<div class="method-example">
<pre>
<code class="ruby">React::User.create(
:name => "John McClane",
:email => "[email protected]",
:country => "US",
:some_key => "yey_JA390094AWPIWWN435",
:age => 53
)
</code><code class="python">react.User.create(
name="John McClane",
email="[email protected]",
country="US",
some_key="yey_JA390094AWPIWWN435",
age=53
)
</code><code class="php">React_User::create(array(
"name" => "John McClane",
"email" => "[email protected]",
"country" => "US",
"some_key" => "yey_JA390094AWPIWWN435",
"age" => 53
));
</code>
<code class="ruby always-visible"># Object Response
{
"object": "User",
"name": "John McClane",
"email": "[email protected]",
"country": "US",
"some_key": "yey_JA390094AWPIWWN435",
"age": 53
"address": {
"address_line1": null,
"address_line2": null,
"address_city": null,
"address_state": null,
"address_zip": null,
"address_country": null
}
"valid": true,
"description": null
}
</code>
</pre>
</div>
</div>
</div>
<div class="method" id="orders">
<div class="method-section clearfix">
<div class="method-description">
<h3>Orders</h3>
<p>
It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.
</p>
</div>
<div class="method-example">
<pre>
<code class="ruby">React::Order.create(
:item => "React Bootstrap Theme",
:price => 1500,
:name => "John McClane",
:email => "[email protected]",
:country => "US",
:some_key => "yey_JA390094AWPIWWN435",
:age => 53
)
</code><code class="python">react.User.create(
item="React Bootstrap Theme",
price=1500,
name="John McClane",
email="[email protected]",
country="US",
some_key="yey_JA390094AWPIWWN435",
age=53
)
</code><code class="php">React_User::create(array(
"item" => "React Bootstrap Theme",
"price" => 1500,
"name" => "John McClane",
"email" => "[email protected]",
"country" => "US",
"some_key" => "yey_JA390094AWPIWWN435",
"age" => 53
));
</code>
<code class="ruby always-visible"># Object Response
{
"object": "Order",
"item": "React Bootstrap Theme",
"price": 1500,
"name": "John McClane",
"email": "[email protected]",
"country": "US",
"some_key": "yey_JA390094AWPIWWN435",
"age": 53
"address": {
"address_line1": null,
"address_line2": null,
"address_city": null,
"address_state": null,
"address_zip": null,
"address_country": null
}
"valid": true,
"description": null
}
</code>
</pre>
</div>
</div>
</div>
<div class="method" id="errors">
<div class="method-section clearfix">
<div class="method-description">
<h3>Errors</h3>
<p>
Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book.
</p>
<div class="info">
<h4>Attributes</h4>
<div class="field clearfix">
<div class="key">code:</div>
<div class="desc">
<strong>string</strong>
Code of the error
</div>
</div>
<div class="field clearfix">
<div class="key">message:</div>
<div class="desc">
<strong>string</strong>
A complete message with details about the error to show users.
</div>
</div>
</div>
</div>
<div class="method-example">
<pre>
<code class="http always-visible">200 OK - Everything worked.
400 Bad Request - The request was badly built
401 Unauthorized - Some other message
402 Request Failed - The request failed
404 Not Found - Doesn't exist
500, 502, 503, 504 Server errors
</code>
</pre>
</div>
</div>
</div>
</div>
</div>
<script type="text/javascript">
$(function () {
hljs.configure({
tabReplace: ' ',
classPrefix: ''
})
hljs.initHighlightingOnLoad();
// language toggle
var $languages = $(".languages .language");
$languages.click(function (e) {
e.preventDefault();
var lang = $(this).data("lang");
$languages.removeClass("selected");
$(this).addClass("selected");
$("pre code").hide();
$("pre code." + lang).css("display", "block");
});
});
</script>
</body>
</html>