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-16 12:28:58 +01:00
parent 9d8c517b82
commit e9a2da4bd8
4 changed files with 128 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

69
docs/api_data.js
View File

@ -12,8 +12,8 @@ define({ "api": [
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
@ -69,8 +69,8 @@ define({ "api": [
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
@ -99,6 +99,36 @@ define({ "api": [
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/auth/reset-password",
"title": "Reset password",
"name": "ResetPass",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/note",
@ -157,7 +187,7 @@ define({ "api": [
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 403 Not Found\n{\n \"success\": false,\n \"message\": \"Access forbidden.\",\n \"errors\": []\n}",
"content": "HTTP/1.1 403 Forbidden\n{\n \"success\": false,\n \"message\": \"Access forbidden.\",\n \"errors\": []\n}",
"type": "json"
}
]
@ -278,7 +308,7 @@ define({ "api": [
{
"type": "get",
"url": "/user/me",
"title": "Get user information",
"title": "Get account information",
"name": "GetUser",
"group": "User",
"success": {
@ -318,6 +348,33 @@ define({ "api": [
"title": "Update account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Firstname",
"description": "<p>new firstname.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Lastname",
"description": "<p>new lastname.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Email",
"description": "<p>new email address.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [

69
docs/api_data.json
View File

@ -12,8 +12,8 @@
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
@ -69,8 +69,8 @@
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
@ -99,6 +99,36 @@
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/auth/reset-password",
"title": "Reset password",
"name": "ResetPass",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>email of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/note",
@ -157,7 +187,7 @@
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 403 Not Found\n{\n \"success\": false,\n \"message\": \"Access forbidden.\",\n \"errors\": []\n}",
"content": "HTTP/1.1 403 Forbidden\n{\n \"success\": false,\n \"message\": \"Access forbidden.\",\n \"errors\": []\n}",
"type": "json"
}
]
@ -278,7 +308,7 @@
{
"type": "get",
"url": "/user/me",
"title": "Get user information",
"title": "Get account information",
"name": "GetUser",
"group": "User",
"success": {
@ -318,6 +348,33 @@
"title": "Update account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Firstname",
"description": "<p>new firstname.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Lastname",
"description": "<p>new lastname.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Email",
"description": "<p>new email address.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [

2
docs/api_project.js
View File

@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-11-15T18:00:50.902Z",
"time": "2018-11-16T10:11:39.561Z",
"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-15T18:00:50.902Z",
"time": "2018-11-16T10:11:39.561Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}