-
Notifications
You must be signed in to change notification settings - Fork 0
/
spec.html
476 lines (375 loc) · 32.2 KB
/
spec.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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>RestDoc</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="RestDoc - Documenting REST APIs">
<meta name="author" content="">
<!-- Le styles -->
<link href="bootstrap/css/bootstrap.css" rel="stylesheet">
<link href="bootstrap/css/font-awesome.min.css" rel="stylesheet">
<style type="text/css">
body {
padding-top: 20px;
padding-bottom: 40px;
}
/* Custom container */
.container-narrow {
margin: 0 auto;
max-width: 700px;
}
.container-narrow > hr {
margin: 30px 0;
}
</style>
<link href="bootstrap/css/bootstrap-responsive.css" rel="stylesheet">
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-40427801-1', 'restdoc.org');
ga('send', 'pageview');
</script>
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Fav and touch icons -->
<link rel="apple-touch-icon-precomposed" sizes="144x144" href="bootstrap/ico/apple-touch-icon-144-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="114x114" href="bootstrap/ico/apple-touch-icon-114-precomposed.png">
<link rel="apple-touch-icon-precomposed" sizes="72x72" href="bootstrap/ico/apple-touch-icon-72-precomposed.png">
<link rel="apple-touch-icon-precomposed" href="bootstrap/ico/apple-touch-icon-57-precomposed.png">
<link rel="shortcut icon" href="bootstrap/ico/favicon.png">
</head>
<body>
<div class="container-narrow">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="index.html">Home</a></li>
<li class="active"><a href="spec.html">Specification</a></li>
<li><a href="tooling.html">Tooling</a></li>
<li><a href="refs.html">References</a></li>
<li><a href="contact.html">Contact</a></li>
<li><a href="http://www.github.com/RestDoc" target="_blank">GitHub</a></li>
</ul>
<h3 class="muted">RestDoc</h3>
</div>
<hr>
<h1>RestDoc - Documenting REST APIs</h1>
<h1>Version 1 (2012-12-02)</h1>
<h2>1. Introduction</h2>
<h3>1.1 About REST</h3>
<p>REpresentational State Transfer (REST) is a style of software architecture for distributed systems such as the World Wide Web. The term representational state transfer was introduced and defined in 2000 by Roy Fielding in his doctoral dissertation.[<a href="http://www.ics.uci.edu/%7Efielding/pubs/dissertation/top.htm" title="R. Fielding - Architectural Styles and the Design of Network-based Software Architectures, Chapter 5">REST</a>] </p>
<p>The REST architectural style was developed in parallel with HTTP/1.1, based on the existing design of HTTP/1.0. The largest implementation of a system conforming to the REST architectural style is the World Wide Web. REST exemplifies how the Web's architecture emerged by characterizing and constraining the macro-interactions of the four components of the Web, namely origin servers, gateways, proxies and clients, without imposing limitations on the individual participants. As such, REST essentially governs the proper behavior of participants.
REST-style architectures consist of clients and servers. Clients initiate requests to servers; servers process requests and return appropriate responses. Requests and responses are built around the transfer of representations of resources. A resource can be essentially any coherent and meaningful concept that may be addressed. A representation of a resource is typically a document that captures the current or intended state of a resource.
The client begins sending requests when it is ready to make the transition to a new state. While one or more requests are outstanding, the client is considered in transition. The representation of each application state contains links that may be used the next time the client chooses to initiate a new state transition.
REST facilitates the transaction between web servers by allowing loose coupling between different services. REST is less strongly typed than its counterpart, SOAP. The REST language is based on the use of nouns and verbs, and has an emphasis on readability.</p>
<p>Source: Wikipedia[<a href="http://en.wikipedia.org/wiki/Representational_state_transfer" title="Wikipedia - Representational state transfer">WikiREST</a>]</p>
<h3>1.2. Terminology</h3>
<p>The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119. [<a href="http://www.ietf.org/rfc/rfc2119.txt" title="RFC 2119 - Key words for use in RFCs to Indicate Requirement Levels">RFC2119</a>]</p>
<h3>1.3 REST API Example</h3>
<p>For this specification a simple API for setting and retrieving localized messages is used.</p>
<pre><code>---------------------- ----------------- --------- ------------------------ --------------
Resource Id Methods Representation Status Codes
---------------------- ----------------- --------- ------------------------ --------------
/{locale}/{messageId} LocalizedMessage GET, PUT message format (string) 200, 201, 404
/fallback/{locale} FallbackLocale GET, PUT language format (string) 200, 201
---------------------- ----------------- --------- ------------------------ --------------
</code></pre>
<p>To update or create a new localized message you PUT a string value to it's /{locale}/{messageId} URI. To assign a fallback locale for missing messages, you PUT a locale name to /fallback/{locale}.</p>
<h2>2. Components</h2>
<p>The RestDoc model consist of different components, which are described in the following sections. Each component is part of the root model or is part of another component. The overall structure of RestDoc in defined in chapter <em>3.1</em></p>
<h3>2.1 Resource</h3>
<p>A <em>resource</em> MUST have a unique <em>id</em> that names the resource and SHOULD have a <em>description</em> containing further information about the intended use of the given resource. The <em>path</em> MUST be part of the resource definition and MUST be unique. The path is a URI [<a href="http://www.ietf.org/rfc/rfc2396.txt" title="RFC 2396 - Uniform Resource Identifiers (URI): Generic Syntax">RFC2396</a>] or URI template [<a href="http://www.ietf.org/rfc/rfc6570.txt" title="RFC 6570 - URI Template">RFC6570</a>]. If the path contains variables the resource MUST contain a set of <em>parameter</em> definitions. The resource MUST contain one definition for each available HTTP <em>method</em>.</p>
<p>In the running example there are 2 resources with the paths "/{locale}/{messageId}" and "/fallback/{locale}".</p>
<h3>2.2 Parameter</h3>
<p>A <em>parameter</em> definition is used to define variable expansion for URI templates used in resources paths. A parameter definition SHOULD contain a <em>description</em> describing the given parameter. A parameter MAY define <em>validations</em> for the content.</p>
<p>In the running example there are 2 parameters defined: <code>locale</code> and <code>messageId</code>.</p>
<h3>2.3 Validation</h3>
<p><em>Validations</em> define means to check the content of parameters. Validations are a set of type/pattern pairs with <em>type</em> defining the validation type and <em>pattern</em> containing the regular expression to apply.
Currently the only supported type is <em>match</em>. Multiple entries within one validation set are disjunctive, so the entries are OR'ed.</p>
<h3>2.4 Method</h3>
<p>A <em>method</em> entry represents the pair of <em>HTTP Verb</em> and <em>resource</em>. It SHOULD contain a <em>description</em> that describes the effect of calling this method. It also SHOULD contain a set of <em>status code</em> definitions. A Status Code is represented by an integer with the HTTP Status Code and a textual definition what this return code means. The method SHOULD contain a set of accepted MediaTypes and SHOULD contain a set of request <em>headers</em>. Further the method SHOULD contain a <em>response</em> definition. In addition a method MAY provide a set of <em>examples</em>, each consisting of an expanded path (no templates), a body and optional headers.</p>
<p>In the running example each resource has the two methods GET and PUT. The resource "/{locale}/{messageId}" can return a different set of status codes depending on which method is requested: GET can return 200(OK), or 404(Not Found), while PUT should only ever return 201(Created).</p>
<h3>2.5 Header</h3>
<p>A <em>header</em> is defined by its name as it is used in the HTTP message and SHOULD contain a <em>description</em>. A header can be required or optional with optional being the default. According to the position of the header definition they are API global or method local.</p>
<h3>2.6 MediaTypes</h3>
<p>Request and response MediaTypes can be defined via a type/schema pair. <em>type</em> is the MediaType as defined in [<a href="http://www.ietf.org/rfc/rfc4288.txt" title="RFC 4288 - Media Type Specifications and Registration Procedures">RFC4288</a>] and schema defines the URI of the content schema. (e.g. XSD, JSON-Schema, etc) The schema field is optional.</p>
<h3>2.7 Response</h3>
<p>The response definition consists of a set of MediaTypes for return values and a set of response headers. Both sets are optional.</p>
<h3>2.8 Schema</h3>
<p>A schema is identified by its URI. There are two types of schema definitions. If the MediaType is JSON the schema can be defined inline. The second option is to point to the URL containing the schema document.</p>
<h2>3. RestDoc</h2>
<h3>3.1 Structure</h3>
<p>The overall structure of a RestDoc documentation consists of an optional schema set, an optional global headers set and a required resource set.</p>
<h3>3.2 Retrieval</h3>
<p>The retrieval of the RestDoc documentation is done via the HTTP OPTIONS verb. Querying the server with a path (<code>OPTIONS /xyz HTTP/1.1</code>) MUST return a RestDoc documentation with all resources available with paths beginning with /xyz.</p>
<p>Performing an OPTIONS request with an unexpanded URI path MUST return a RestDoc resource description. Given our example application the request <code>OPTIONS /%7Blocale%7D/%7BmessageId%7D HTTP/1.1</code> MUST return the RestDoc resource description for the "LocalizedMessage" resource.</p>
<h2>4. Representations</h2>
<h3>4.1 JSON</h3>
<p>The default representation of RestDoc is JSON with the custom MediaType <code>application/x-restdoc+json</code>. In the following you find a textual definition of the RestDoc JSON representation.</p>
<p>The root object consist of two object with the names <em>schema</em> and <em>headers</em> and an array <em>resources</em>. </p>
<p>The <em>schema</em> object contains objects with the schema URI as name and the schema definition as content. The content contains a field type with value <em>inline</em> or <em>url</em>. Inline schemas provide a schema object with inline JSON-Schema and URL schemas provide a field url with the URL of the schema document.</p>
<div class="highlight"><pre> <span class="s2">"schemas"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"http://some.json/msg"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"inline"</span><span class="p">,</span>
<span class="s2">"schema"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="s2">"properties"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"id"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"string"</span>
<span class="p">},</span>
<span class="s2">"content"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"string"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"http://some.xml/msg"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"url"</span><span class="p">,</span>
<span class="s2">"url"</span> <span class="o">:</span> <span class="s2">"http://some.xml/msg.xsd"</span>
<span class="p">}</span>
<span class="p">},</span>
</pre></div>
<p>The <em>headers</em> object contains a <em>request</em> and a <em>response</em> object. The contents of these objects are itself objects with the header name as field name and the content as described in <em>Section 2.5</em></p>
<div class="highlight"><pre> <span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"request"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"Authorization"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"See http://myapi.com/docs/auth"</span><span class="p">,</span>
<span class="s2">"required"</span><span class="o">:</span> <span class="kc">true</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"response"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"X-RateLimit-Total"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"The number of API calls allowed per-hour"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
</pre></div>
<p>The resources array consist of objects with the following fields:</p>
<ul>
<li>id: the id of the resource</li>
<li>description: the resource description</li>
<li>path: the resource URI or URI template</li>
<li>params: the parameter object</li>
<li>methods: the method object</li>
</ul><p>The <em>params</em> object has the parameter names as field names and an object as content:</p>
<ul>
<li>description: the parameter description</li>
<li>validations: array of parameter validations
<ul>
<li>type: the validation type (match)</li>
<li>pattern: the regular expression</li>
</ul>
</li>
</ul><div class="highlight"><pre> <span class="s2">"params"</span><span class="o">:</span> <span class="p">{</span> <span class="c1">// URI parameters descriptions</span>
<span class="s2">"locale"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A standard locale string, e.g. \"en_US.utf-8\""</span><span class="p">,</span>
<span class="s2">"validations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span>
<span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span>
<span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"[a-z]+(_[A-Z]+)?(\\\\.[a-z-]+)?"</span>
<span class="p">}</span> <span class="p">]</span>
<span class="p">}</span>
<span class="p">},</span>
</pre></div>
<p>The <em>methods</em> object has HTTP verbs as field names and an object as content:</p>
<ul>
<li>description: the method description</li>
<li>statusCodes: the status code object</li>
<li>accepts: the accept MediaTypes</li>
<li>headers: the headers object</li>
<li>response: the response object with types and headers
<ul>
<li>types: the response MediaTypes</li>
<li>headers: the response headers object</li>
</ul>
</li>
<li>examples: array of example objects
<ul>
<li>path: the expanded path URI</li>
<li>headers: request headers</li>
<li>body: the example request body</li>
</ul>
</li>
</ul><p>see <em>Section 5.1</em> for a full example of a JSON representation of RestDoc</p>
<h2>5. Examples</h2>
<h3>5.1 Full RestDoc example</h3>
<div class="highlight"><pre><span class="nx">OPTIONS</span> <span class="o">/</span> <span class="nx">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
<span class="nx">Accept</span><span class="o">:</span> <span class="nx">application</span><span class="o">/</span><span class="nx">x</span><span class="o">-</span><span class="nx">restdoc</span><span class="o">+</span><span class="nx">json</span><span class="p">;</span>
<span class="p">{</span>
<span class="s2">"schemas"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"http://some.json/msg"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"inline"</span><span class="p">,</span>
<span class="s2">"schema"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"object"</span><span class="p">,</span>
<span class="s2">"properties"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"id"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"string"</span>
<span class="p">},</span>
<span class="s2">"content"</span> <span class="o">:</span> <span class="p">{</span>
<span class="s2">"type"</span> <span class="o">:</span> <span class="s2">"string"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="c1">// Headers can be described at the server level and/or per-method</span>
<span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"request"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"Authorization"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"This server uses a custom authentication scheme. See http://myapi.com/docs/auth"</span><span class="p">,</span>
<span class="s2">"required"</span><span class="o">:</span> <span class="kc">true</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"response"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"X-RateLimit-Total"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"The number of API calls allowed per-hour"</span>
<span class="p">},</span>
<span class="s2">"X-RateLimit-Remaining"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Number of requests remaining until next refill"</span>
<span class="p">},</span>
<span class="s2">"X-RateLimit-Reset"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"The time at which X-RateLimit-Remaining will be reset back to X-RateLimit-Total"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"resources"</span><span class="o">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"LocalizedMessage"</span><span class="p">,</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A localized message"</span><span class="p">,</span>
<span class="s2">"path"</span><span class="o">:</span> <span class="s2">"/{locale}/{messageId}{?seasonal}"</span><span class="p">,</span> <span class="c1">// representing query params with L3 URI templates</span>
<span class="s2">"params"</span><span class="o">:</span> <span class="p">{</span> <span class="c1">// URI parameters descriptions</span>
<span class="s2">"locale"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A standard locale string, e.g. \"en_US.utf-8\""</span><span class="p">,</span>
<span class="s2">"validations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span> <span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"[a-z]+(_[A-Z]+)?(\\\\.[a-z-]+)?"</span> <span class="p">}</span> <span class="p">]</span>
<span class="p">},</span>
<span class="s2">"messageId"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"A free-form message string"</span><span class="p">,</span>
<span class="s2">"validations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span> <span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"[a-z_]+"</span> <span class="p">}</span> <span class="p">]</span>
<span class="p">},</span>
<span class="s2">"seasonal"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Whether the message is seasonal."</span><span class="p">,</span>
<span class="s2">"validations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span> <span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"^(true|false|yes|no)$"</span> <span class="p">}</span> <span class="p">]</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"methods"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"PUT"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Update or create a message"</span><span class="p">,</span>
<span class="s2">"statusCodes"</span><span class="o">:</span> <span class="p">{</span> <span class="s2">"201"</span><span class="o">:</span> <span class="s2">"Created"</span> <span class="p">},</span>
<span class="s2">"accepts"</span><span class="o">:</span> <span class="p">[</span> <span class="c1">// Representations accepted by the method on this resource.</span>
<span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"text/plain"</span> <span class="p">},</span>
<span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"application/json"</span><span class="p">,</span> <span class="s2">"schema"</span><span class="o">:</span> <span class="s2">"http://some.json/msg"</span> <span class="p">}</span>
<span class="p">],</span>
<span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span> <span class="c1">// Request headers only, response headers are defined under 'response'</span>
<span class="s2">"X-User-Token"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Used to identify the user creating the message"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"response"</span><span class="o">:</span> <span class="p">{</span> <span class="c1">// Response representations this resource/method provides</span>
<span class="s2">"types"</span><span class="o">:</span> <span class="p">[</span>
<span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"text/plain"</span> <span class="p">},</span>
<span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"application/json"</span><span class="p">,</span> <span class="s2">"schema"</span><span class="o">:</span> <span class="s2">"http://some.json/msg"</span> <span class="p">}</span>
<span class="p">],</span>
<span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"Location"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"The URL of the created message"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"examples"</span><span class="o">:</span> <span class="p">[</span>
<span class="p">{</span>
<span class="s2">"path"</span><span class="o">:</span> <span class="s2">"/en_US/greeting"</span><span class="p">,</span>
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"Hello, world!"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="s2">"path"</span><span class="o">:</span> <span class="s2">"/en_US/greeting"</span><span class="p">,</span>
<span class="s2">"headers"</span><span class="o">:</span> <span class="p">{</span><span class="s2">"Content-Type"</span><span class="o">:</span> <span class="s2">"application/json"</span><span class="p">},</span>
<span class="s2">"body"</span><span class="o">:</span> <span class="s2">"{\"id\":\"greeting\",\"content\":\"Hello, world!\"}!"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
<span class="s2">"GET"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"description"</span><span class="o">:</span> <span class="s2">"Retrieve a message"</span><span class="p">,</span>
<span class="s2">"statusCodes"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"200"</span><span class="o">:</span> <span class="s2">"Message retrieved successfully"</span><span class="p">,</span>
<span class="s2">"404"</span><span class="o">:</span> <span class="s2">"Message not found"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="c1">// This resource has no human-readable documentation, but still provides some info on how to use it.</span>
<span class="s2">"id"</span><span class="o">:</span> <span class="s2">"FallbackLocale"</span><span class="p">,</span>
<span class="s2">"path"</span><span class="o">:</span> <span class="s2">"/fallback/{locale}"</span><span class="p">,</span>
<span class="s2">"params"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"locale"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"validations"</span><span class="o">:</span> <span class="p">[</span> <span class="p">{</span> <span class="s2">"type"</span><span class="o">:</span> <span class="s2">"match"</span><span class="p">,</span> <span class="s2">"pattern"</span><span class="o">:</span> <span class="s2">"[a-z]+(_[A-Z]+)?(\\\\.[a-z-]+)?"</span> <span class="p">}</span> <span class="p">]</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="s2">"methods"</span><span class="o">:</span> <span class="p">{</span>
<span class="s2">"GET"</span><span class="o">:</span> <span class="p">{</span> <span class="s2">"statusCodes"</span><span class="o">:</span> <span class="p">{</span> <span class="s2">"200"</span><span class="o">:</span> <span class="s2">"OK"</span> <span class="p">}</span> <span class="p">},</span>
<span class="s2">"PUT"</span><span class="o">:</span> <span class="p">{</span> <span class="s2">"statusCodes"</span><span class="o">:</span> <span class="p">{</span> <span class="s2">"201"</span><span class="o">:</span> <span class="s2">"Created"</span> <span class="p">}</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
</pre></div>
<h2>6. Extensions</h2>
<h3>6.1 Extensibility</h3>
<p>RestDoc is designed to be extensible. Therefore any additional fields not named in this specification MUST be ignored by implementations that do not understand them. But implementations MUST NOT rely on any additional fields to be RestDoc compliant. Extensions MUST NOT change the meaning of fields defined in this specification.</p>
<p>An extension may for example defined other validation types than <em>match</em> but must not change the behavior of the type <em>match</em>.</p>
<h3>6.2 Naming conventions</h3>
<p>Extensions to RestDoc are given a unique name beginning with <em>RestDoc-</em>. The example extension above could be named <em>RestDoc-Validations</em>.</p>
<h2>7. Copyright</h2>
<p>This specification is copyrighted by the authors named in section 7.1. It is free to use for any purposes commercial or non-commercial.</p>
<h3>7.1 Authors</h3>
<p>The following authors are responsible for the RestDoc core-specification:</p>
<pre><code>Thorsten Hoeger
Taimos GmbH
Hohenzollernstrasse 32
D-73262 Reichenbach
</code></pre>
<pre><code>Saar Yahalom
Microsoft
Shenkar 13, Hertzeliya
Israel
saary .at. microsoft.com
</code></pre>
<pre><code>Stephen Sugden
Bet Smart Media
19 Bastion Square, Victoria
British Columbia, Canada
</code></pre>
<pre><code>Zac Stewart
Big Nerd Ranch
112 Krog St SESuite 6
Atlanta, GA 30312
</code></pre>
<h3>7.2 Contact</h3>
<p>This specification and any related work is located at <a href="http://www.restdoc.org">http://www.restdoc.org</a> and <a href="https://github.com/RestDoc">https://github.com/RestDoc</a>.
Discussion and help can be found on the RestDoc Google group located at <a href="https://groups.google.com/d/forum/restdoc">https://groups.google.com/d/forum/restdoc</a></p>
<h2>A. References</h2>
<h3>A.1 Normative</h3>
<p>[RFC2119]: RFC 2119 - Key words for use in RFCs to Indicate Requirement Levels</p>
<p>[RFC4627]: RFC 4627 - The application/json Media Type for JavaScript Object Notation (JSON)</p>
<p>[RFC6570]: RFC 6570 - URI Template</p>
<p>[RFC4288]: RFC 4288 - Media Type Specifications and Registration Procedures</p>
<p>[RFC2396]: RFC 2396 - Uniform Resource Identifiers (URI): Generic Syntax</p>
<p>[RFC2616]: RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1</p>
<p>[XML]: W3C - Extensible Markup Language (XML) 1.0 (Fifth Edition)</p>
<h3>A.2 Informative</h3>
<p>[REST]: R. Fielding - Architectural Styles and the Design of Network-based Software Architectures, Chapter 5</p>
<p>[WikiREST]: "Wikipedia - Representational state transfer"</p>
<hr>
<div class="footer">
<p>© RestDoc.org 2013 <a href="imprint.html">Imprint</a></p>
<p><small>Using <a href="http://twitter.github.com/bootstrap/">Bootstrap</a> and <a href="http://fortawesome.github.com/Font-Awesome">FontAwesome</a></small></p>
</div>
</div> <!-- /container -->
</body>
</html>