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

Docs

pull/1/head
sundowndev 2018-11-12 18:19:39 +01:00
parent d6aeee2eae
commit f87986fd69
4 changed files with 552 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

276
docs/api_data.js
View File

@ -1,4 +1,137 @@
define({ "api": [
{
"type": "post",
"url": "/auth/login",
"title": "Request JWT token",
"name": "Login",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "jwt",
"description": "<p>JWT token.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/auth/register",
"title": "Register",
"name": "Register",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>Array of Note objects.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/note",
"title": "Create note",
"name": "CreateNote",
"group": "Note",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "Object",
"description": "<p>Created note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/note/:id",
"title": "Delete a note",
"name": "DeleteNote",
"group": "Note",
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "get",
"url": "/note",
@ -65,6 +198,43 @@ define({ "api": [
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/user/me",
"title": "Delete current account",
"name": "DeleteUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/:id",
@ -115,6 +285,43 @@ define({ "api": [
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/me",
"title": "Request current account information",
"name": "GetUser",
"group": "User",
"success": {
"fields": {
"Success 200": [
{
"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": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user",
@ -142,7 +349,7 @@ define({ "api": [
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>Array of User objects.</p>"
"description": "<p>User objects.</p>"
}
]
}
@ -150,5 +357,72 @@ define({ "api": [
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "put",
"url": "/user/me",
"title": "Update current account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/me/notes",
"title": "Get notes created by this account",
"name": "GetNotes",
"group": "User_Note",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "title",
"description": "<p>Title of the note.</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>Text of the note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User_Note"
}
] });

276
docs/api_data.json
View File

@ -1,4 +1,137 @@
[
{
"type": "post",
"url": "/auth/login",
"title": "Request JWT token",
"name": "Login",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "jwt",
"description": "<p>JWT token.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/auth/register",
"title": "Register",
"name": "Register",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>username of the user.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password of the user.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>Array of Note objects.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/auth/index.js",
"groupTitle": "Auth"
},
{
"type": "post",
"url": "/note",
"title": "Create note",
"name": "CreateNote",
"group": "Note",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "Object",
"description": "<p>Created note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/note/:id",
"title": "Delete a note",
"name": "DeleteNote",
"group": "Note",
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "get",
"url": "/note",
@ -65,6 +198,43 @@
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/user/me",
"title": "Delete current account",
"name": "DeleteUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/:id",
@ -115,6 +285,43 @@
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/me",
"title": "Request current account information",
"name": "GetUser",
"group": "User",
"success": {
"fields": {
"Success 200": [
{
"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": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user",
@ -142,7 +349,7 @@
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>Array of User objects.</p>"
"description": "<p>User objects.</p>"
}
]
}
@ -150,5 +357,72 @@
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "put",
"url": "/user/me",
"title": "Update current account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "firstname",
"description": "<p>Firstname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "lastname",
"description": "<p>Lastname of the User.</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>Username of the User.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user/me/notes",
"title": "Get notes created by this account",
"name": "GetNotes",
"group": "User_Note",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "title",
"description": "<p>Title of the note.</p>"
},
{
"group": "Success 200",
"type": "string",
"optional": false,
"field": "text",
"description": "<p>Text of the note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User_Note"
}
]

2
docs/api_project.js
View File

@ -8,7 +8,7 @@ define({
"apidoc": "0.3.0",
"generator": {
"name": "apidoc",
"time": "2018-11-12T15:27:44.007Z",
"time": "2018-11-12T17:15:53.319Z",
"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-12T15:27:44.007Z",
"time": "2018-11-12T17:15:53.319Z",
"url": "http://apidocjs.com",
"version": "0.17.7"
}