git.iko.soy/typeable/servant
on servant-foreign-0.15.1 help sign in
typeable/servant/servant-docs/golden/comprehensive.md
570 lines 8.1 kB history raw
1## GET /
3### Response:
5- Status code 200
6- Headers: []
8- Supported content types are:
10 - `application/json;charset=utf-8`
11 - `application/json`
13- Example (`application/json;charset=utf-8`, `application/json`):
15```javascript
17```
19## GET /alternative/left
21### Response:
23- Status code 200
24- Headers: []
26- Supported content types are:
28 - `application/json;charset=utf-8`
29 - `application/json`
31- Example (`application/json;charset=utf-8`, `application/json`):
33```javascript
35```
37## GET /alternative/right
39### Response:
41- Status code 200
42- Headers: []
44- Supported content types are:
46 - `application/json;charset=utf-8`
47 - `application/json`
49- Example (`application/json;charset=utf-8`, `application/json`):
51```javascript
53```
55## GET /capture/:foo
57### Captures:
59- *foo*: Capture foo Int
61### Response:
63- Status code 200
64- Headers: []
66- Supported content types are:
68 - `application/json;charset=utf-8`
69 - `application/json`
71- Example (`application/json;charset=utf-8`, `application/json`):
73```javascript
75```
77## GET /capture-all/:foo
79### Captures:
81- *foo*: Capture all foo Int
83### Response:
85- Status code 200
86- Headers: []
88- Supported content types are:
90 - `application/json;charset=utf-8`
91 - `application/json`
93- Example (`application/json;charset=utf-8`, `application/json`):
95```javascript
97```
99## GET /capture-lenient/:foo
101### Captures:
103- *foo*: Capture foo Int
105### Response:
107- Status code 200
108- Headers: []
110- Supported content types are:
112 - `application/json;charset=utf-8`
113 - `application/json`
115- Example (`application/json;charset=utf-8`, `application/json`):
117```javascript
119```
121## GET /description
123### foo
126### Response:
128- Status code 200
129- Headers: []
131- Supported content types are:
133 - `application/json;charset=utf-8`
134 - `application/json`
136- Example (`application/json;charset=utf-8`, `application/json`):
138```javascript
140```
142## GET /flag
144### GET Parameters:
146- foo
147 - **Description**: QueryFlag
148 - This parameter is a **flag**. This means no value is expected to be associated to this parameter.
151### Response:
153- Status code 200
154- Headers: []
156- Supported content types are:
158 - `application/json;charset=utf-8`
159 - `application/json`
161- Example (`application/json;charset=utf-8`, `application/json`):
163```javascript
165```
167## GET /foo
169### Response:
171- Status code 200
172- Headers: []
174- Supported content types are:
176 - `application/json;charset=utf-8`
177 - `application/json`
179- Example (`application/json;charset=utf-8`, `application/json`):
181```javascript
183```
185## GET /get-int
187### Response:
189- Status code 200
190- Headers: []
192- Supported content types are:
194 - `application/json;charset=utf-8`
195 - `application/json`
197- Example (`application/json;charset=utf-8`, `application/json`):
199```javascript
20017
201```
203## GET /header
205### Headers:
207- This endpoint is sensitive to the value of the **foo** HTTP header.
209### Response:
211- Status code 200
212- Headers: []
214- Supported content types are:
216 - `application/json;charset=utf-8`
217 - `application/json`
219- Example (`application/json;charset=utf-8`, `application/json`):
221```javascript
223```
225## GET /header-lenient
227### Headers:
229- This endpoint is sensitive to the value of the **bar** HTTP header.
231### Response:
233- Status code 200
234- Headers: []
236- Supported content types are:
238 - `application/json;charset=utf-8`
239 - `application/json`
241- Example (`application/json;charset=utf-8`, `application/json`):
243```javascript
245```
247## GET /http-version
249### Response:
251- Status code 200
252- Headers: []
254- Supported content types are:
256 - `application/json;charset=utf-8`
257 - `application/json`
259- Example (`application/json;charset=utf-8`, `application/json`):
261```javascript
263```
265## GET /is-secure
267### Response:
269- Status code 200
270- Headers: []
272- Supported content types are:
274 - `application/json;charset=utf-8`
275 - `application/json`
277- Example (`application/json;charset=utf-8`, `application/json`):
279```javascript
281```
283## GET /named-context
285### Response:
287- Status code 200
288- Headers: []
290- Supported content types are:
292 - `application/json;charset=utf-8`
293 - `application/json`
295- Example (`application/json;charset=utf-8`, `application/json`):
297```javascript
299```
301## GET /param
303### GET Parameters:
305- foo
306 - **Values**: *1, 2, 3*
307 - **Description**: QueryParams Int
310### Response:
312- Status code 200
313- Headers: []
315- Supported content types are:
317 - `application/json;charset=utf-8`
318 - `application/json`
320- Example (`application/json;charset=utf-8`, `application/json`):
322```javascript
324```
326## GET /param-lenient
328### GET Parameters:
330- bar
331 - **Values**: *1, 2, 3*
332 - **Description**: QueryParams Int
335### Response:
337- Status code 200
338- Headers: []
340- Supported content types are:
342 - `application/json;charset=utf-8`
343 - `application/json`
345- Example (`application/json;charset=utf-8`, `application/json`):
347```javascript
349```
351## GET /params
353### GET Parameters:
355- foo
356 - **Values**: *1, 2, 3*
357 - **Description**: QueryParams Int
358 - This parameter is a **list**. All GET parameters with the name foo[] will forward their values in a list to the handler.
361### Response:
363- Status code 200
364- Headers: []
366- Supported content types are:
368 - `application/json;charset=utf-8`
369 - `application/json`
371- Example (`application/json;charset=utf-8`, `application/json`):
373```javascript
375```
377## POST /post-int
379### Response:
381- Status code 204
382- Headers: []
384- Supported content types are:
386 - `application/json;charset=utf-8`
387 - `application/json`
389- Example (`application/json;charset=utf-8`, `application/json`):
391```javascript
39217
393```
395## POST /post-no-content
397### Response:
399- Status code 204
400- Headers: []
402- No response body
404## GET /raw
406### Response:
408- Status code 200
409- Headers: []
411- No response body
413## GET /remote-host
415### Response:
417- Status code 200
418- Headers: []
420- Supported content types are:
422 - `application/json;charset=utf-8`
423 - `application/json`
425- Example (`application/json;charset=utf-8`, `application/json`):
427```javascript
429```
431## GET /req-body
433### Request:
435- Supported content types are:
437 - `application/json;charset=utf-8`
438 - `application/json`
440- Example (`application/json;charset=utf-8`, `application/json`):
442```javascript
44317
444```
446### Response:
448- Status code 200
449- Headers: []
451- Supported content types are:
453 - `application/json;charset=utf-8`
454 - `application/json`
456- Example (`application/json;charset=utf-8`, `application/json`):
458```javascript
460```
462## GET /req-body-lenient
464### Request:
466- Supported content types are:
468 - `application/json;charset=utf-8`
469 - `application/json`
471- Example (`application/json;charset=utf-8`, `application/json`):
473```javascript
47417
475```
477### Response:
479- Status code 200
480- Headers: []
482- Supported content types are:
484 - `application/json;charset=utf-8`
485 - `application/json`
487- Example (`application/json;charset=utf-8`, `application/json`):
489```javascript
491```
493## GET /res-headers
495### Response:
497- Status code 200
498- Headers: [("foo","17")]
500- Supported content types are:
502 - `application/json;charset=utf-8`
503 - `application/json`
505- Example (`application/json;charset=utf-8`, `application/json`):
507```javascript
509```
511## GET /streaming
513### Request:
515- Supported content types are:
517 - `application/json;charset=utf-8`
518 - `application/json`
520### Response:
522- Status code 200
523- Headers: []
525- Supported content types are:
527 - `application/json;charset=utf-8`
528 - `application/json`
530- No response body
532## GET /summary
534### foo
537### Response:
539- Status code 200
540- Headers: []
542- Supported content types are:
544 - `application/json;charset=utf-8`
545 - `application/json`
547- Example (`application/json;charset=utf-8`, `application/json`):
549```javascript
551```
553## GET /vault
555### Response:
557- Status code 200
558- Headers: []
560- Supported content types are:
562 - `application/json;charset=utf-8`
563 - `application/json`
565- Example (`application/json;charset=utf-8`, `application/json`):
567```javascript
569```