UNPKG

apidoc

Version:

RESTful web API Documentation Generator

apidocjs.com

apidoc/apidoc

30 lines (29 loc) • 1.08 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
/** * @api {get} /test/:id Grouping * @apiName GetGrouping * @apiGroup Grouping * @apiVersion 0.1.0 * @apiDescription Title and Grouping of param, success and error * * * @apiParam {String} param1 No Group, automatically set Group to "Parameter" * * @apiParamTitle (login) Replace "login" with this text * @apiParam (login) {String} param2 Group "login" * @apiParam (login) {String} param3="Default Value" Group "login" with default Value * * * @apiSuccess {String} success1 No Group, automatically set "Success 200" * * @apiSuccessTitle (201) 201 - Everything ok, replace "201" with this text. * @apiSuccess (201) {String} success2 Group "201" * @apiSuccess (201) {String} success3="Default Value" Group "201" with default Value * * * @apiError {String} error1 No Group automatically set "Error 4xx" * * @apiError (400) {String} error2 Group "400" * * @apiErrorTitle (401) 401 - Oh oh, replace "401" with this text * @apiError (401) {String} error3 Group "401" */