UNPKG

apidoc

Version:

RESTful web API Documentation Generator

apidocjs.com

apidoc/apidoc

57 lines (55 loc) • 2.4 kB
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
/** * @api {get} /param/:id Parameters * @apiName GetParam * @apiGroup Param * @apiVersion 0.1.1 * @apiDescription Parameters and different Versions: 0.1.1 * * @apiParam {String} param1 Parameter with type and description. * @apiParam {String} param2 * @apiParam {String} param3="Default Value" Parameter with type, description and default value. * @apiParam {String} param4="Default Value" * * @apiParam param5 Basic Parameter with description. * @apiParam param6 * @apiParam param7="Default Value" Basic Parameter with description and default value. * @apiParam param8="Default Value" * * @apiParam [param9] Optional basic Parameter with description. * @apiParam [param10] * @apiParam [param11="Default Value"] Optional basic Parameter with description and default value. * @apiParam [param12="Default Value"] * * @apiParam {String} [param13] Optional Parameter with type and description. * @apiParam {String} [param14] * @apiParam {String} [param15="Default Value"] Optional Parameter with type, description and default value. * @apiParam {String} [param16="Default Value"] */ /** * @api {get} /param/:id Parameters * @apiName GetParam * @apiGroup Param * @apiVersion 0.1.0 * @apiDescription Parameters and different Versions: 0.1.0 * * @apiParam {String} param0 This param is removed in 0.1.1. * @apiParam {String} param1 This is an old text. * @apiParam {String} param2 * @apiParam {String} param3="Default Value" Parameter with type, description and default value. * @apiParam {String} param4="Default Value" * * @apiParam param5 Basic Parameter with description. * @apiParam param6 * @apiParam param7="Default Value" Basic Parameter with description and default value. * @apiParam param8="Default Value" * * @apiParam [param9] Optional basic Parameter with description. * @apiParam [param10] * @apiParam [param11="Default Value"] Optional basic Parameter with description and default value. * @apiParam [param12="Default Value"] * * @apiParam {String} [param13] Optional Parameter with type and description. * @apiParam {String} [param14] * @apiParam {String} [param15="Default Value"] Optional Parameter with type, description and default value. * @apiParam {String} [param16="Default Value"] */