sundowndev
/
express-api-example
mirror of https://github.com/sundowndev/express-api-example.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

API docs

develop
sundowndev 2018-11-17 01:01:35 +01:00
parent 407f3d3ba7
commit 319d1b9dbd
4 changed files with 66 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
docs/api_data.js
View File

@ -308,7 +308,7 @@ define({ "api": [
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Password",
"field": "password",
"description": "<p>Account password.</p>"
}
]
@ -327,6 +327,13 @@ define({ "api": [
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Unique ID of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
@ -408,10 +415,31 @@ define({ "api": [
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>User object.</p>"
"field": "id",
"description": "<p>Unique ID of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email of the User.</p>"
}
]
}

36
docs/api_data.json
View File

@ -308,7 +308,7 @@
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Password",
"field": "password",
"description": "<p>Account password.</p>"
}
]
@ -327,6 +327,13 @@
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Unique ID of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
@ -408,10 +415,31 @@
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"type": "String",
"optional": false,
"field": "user",
"description": "<p>User object.</p>"
"field": "id",
"description": "<p>Unique ID of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>Email of the User.</p>"
}
]
}

2
docs/api_project.js
View File

@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-11-16T14:21:42.357Z",
"time": "2018-11-17T00:00:47.768Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}

2
docs/api_project.json
View File

@ -8,7 +8,7 @@
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-11-16T14:21:42.357Z",
"time": "2018-11-17T00:00:47.768Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}