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-14 18:16:00 +01:00
parent 72bc53b6a4
commit c9b9ee5d3f
4 changed files with 130 additions and 346 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

236
docs/api_data.js
View File

@ -2,7 +2,7 @@ define({ "api": [
{
"type": "post",
"url": "/auth/login",
"title": "Request JWT token",
"title": "Get access token",
"name": "Login",
"group": "Auth",
"parameter": {
@ -32,7 +32,7 @@ define({ "api": [
"group": "Success 200",
"type": "string",
"optional": false,
"field": "jwt",
"field": "jwt_token",
"description": "<p>JWT token.</p>"
}
]
@ -125,28 +125,18 @@ define({ "api": [
{
"type": "delete",
"url": "/note/:id",
"title": "Delete a note",
"title": "Delete note",
"name": "DeleteNote",
"group": "Note",
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "get",
"url": "/note",
"title": "Request all notes",
"name": "GetNotes",
"group": "Note",
"success": {
"parameter": {
"fields": {
"Success 200": [
"Parameter": [
{
"group": "Success 200",
"type": "Array",
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Array",
"description": "<p>Array of Note objects.</p>"
"field": "id",
"description": "<p>Note unique ID.</p>"
}
]
}
@ -158,7 +148,7 @@ define({ "api": [
{
"type": "get",
"url": "/note/:id",
"title": "Request Note information",
"title": "Get note",
"name": "GetNotes",
"group": "Note",
"parameter": {
@ -166,10 +156,10 @@ define({ "api": [
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Notes unique ID.</p>"
"description": "<p>Note unique ID.</p>"
}
]
}
@ -198,89 +188,48 @@ define({ "api": [
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "put",
"url": "/note/:id",
"title": "Update note",
"name": "UpdateNote",
"group": "Note",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Note unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "Object",
"description": "<p>Updated note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/user/me",
"title": "Delete current account",
"title": "Delete 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",
"title": "Request User information",
"name": "GetUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"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"
@ -288,7 +237,7 @@ define({ "api": [
{
"type": "get",
"url": "/user/me",
"title": "Request current account information",
"title": "Get user information",
"name": "GetUser",
"group": "User",
"success": {
@ -322,71 +271,21 @@ define({ "api": [
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user",
"title": "Request all Users information",
"name": "GetUsers",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>User objects.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "put",
"url": "/user/me",
"title": "Update current account information",
"title": "Update account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"success": {
"fields": {
"Parameter": [
"Success 200": [
{
"group": "Parameter",
"type": "String",
"group": "Success 200",
"type": "Object",
"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>"
"field": "user",
"description": "<p>User object.</p>"
}
]
}
@ -398,31 +297,24 @@ define({ "api": [
{
"type": "get",
"url": "/user/me/notes",
"title": "Get notes created by this account",
"name": "GetNotes",
"group": "User_Note",
"title": "Get all notes",
"name": "GetNotesByUserId",
"group": "User_notes",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"type": "Array",
"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>"
"field": "Array",
"description": "<p>Notes of the user.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User_Note"
"groupTitle": "User_notes"
}
] });

236
docs/api_data.json
View File

@ -2,7 +2,7 @@
{
"type": "post",
"url": "/auth/login",
"title": "Request JWT token",
"title": "Get access token",
"name": "Login",
"group": "Auth",
"parameter": {
@ -32,7 +32,7 @@
"group": "Success 200",
"type": "string",
"optional": false,
"field": "jwt",
"field": "jwt_token",
"description": "<p>JWT token.</p>"
}
]
@ -125,28 +125,18 @@
{
"type": "delete",
"url": "/note/:id",
"title": "Delete a note",
"title": "Delete note",
"name": "DeleteNote",
"group": "Note",
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "get",
"url": "/note",
"title": "Request all notes",
"name": "GetNotes",
"group": "Note",
"success": {
"parameter": {
"fields": {
"Success 200": [
"Parameter": [
{
"group": "Success 200",
"type": "Array",
"group": "Parameter",
"type": "String",
"optional": false,
"field": "Array",
"description": "<p>Array of Note objects.</p>"
"field": "id",
"description": "<p>Note unique ID.</p>"
}
]
}
@ -158,7 +148,7 @@
{
"type": "get",
"url": "/note/:id",
"title": "Request Note information",
"title": "Get note",
"name": "GetNotes",
"group": "Note",
"parameter": {
@ -166,10 +156,10 @@
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Notes unique ID.</p>"
"description": "<p>Note unique ID.</p>"
}
]
}
@ -198,89 +188,48 @@
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "put",
"url": "/note/:id",
"title": "Update note",
"name": "UpdateNote",
"group": "Note",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "id",
"description": "<p>Note unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "Object",
"description": "<p>Updated note.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/note/index.js",
"groupTitle": "Note"
},
{
"type": "delete",
"url": "/user/me",
"title": "Delete current account",
"title": "Delete 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",
"title": "Request User information",
"name": "GetUser",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"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"
@ -288,7 +237,7 @@
{
"type": "get",
"url": "/user/me",
"title": "Request current account information",
"title": "Get user information",
"name": "GetUser",
"group": "User",
"success": {
@ -322,71 +271,21 @@
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "get",
"url": "/user",
"title": "Request all Users information",
"name": "GetUsers",
"group": "User",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Number",
"optional": false,
"field": "id",
"description": "<p>Users unique ID.</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Array",
"optional": false,
"field": "Array",
"description": "<p>User objects.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User"
},
{
"type": "put",
"url": "/user/me",
"title": "Update current account information",
"title": "Update account information",
"name": "UpdateUser",
"group": "User",
"parameter": {
"success": {
"fields": {
"Parameter": [
"Success 200": [
{
"group": "Parameter",
"type": "String",
"group": "Success 200",
"type": "Object",
"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>"
"field": "user",
"description": "<p>User object.</p>"
}
]
}
@ -398,31 +297,24 @@
{
"type": "get",
"url": "/user/me/notes",
"title": "Get notes created by this account",
"name": "GetNotes",
"group": "User_Note",
"title": "Get all notes",
"name": "GetNotesByUserId",
"group": "User_notes",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "string",
"type": "Array",
"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>"
"field": "Array",
"description": "<p>Notes of the user.</p>"
}
]
}
},
"version": "0.0.0",
"filename": "app/routes/user/index.js",
"groupTitle": "User_Note"
"groupTitle": "User_notes"
}
]

2
docs/api_project.js
View File

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