Skip to content

dalindev/restapi

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

58 Commits

app

app

 
 

config

config

 
 

public

public

 
 

.eslintrc.js

.eslintrc.js

 
 

.gitignore

.gitignore

 
 

README.md

README.md

 
 

app.js

app.js

 
 

package-lock.json

package-lock.json

 
 

package.json

package.json

 
 

Repository files navigation

restapi

Project structure

restapi
│
├── app.js
├── package.json
├── config
│    ├── conf.json [local config file, should not git this]
│    └── database.js
├── public
│    ├── css
│    └── js
└── app
    ├── config
    │    └── passport
    │        └── passport.js
    ├── controllers
    │    ├── auth_controller.js
    │    └── v1_0
    │        └── messages_controller.js
    │── models
    │    ├── index.js
    │    ├── messages.js
    │    └── user.js
    │── routes
    │    ├── auth_routes.js
    │    └── v1_0
    │        └── messages_routes.js
    │── tools
    │    └── helper_methods.js
    └── views
         ├── body_html [folder]
         ├── body_js [folder]
         ├── header [folder]
         ├── pages [folder]
         └── index.ejs




Setup

  1. git clone this project
  2. npm install
  3. make sure you have MySQL database running
  4. Create a config file conf.json at here /restapi/config/conf.json, put your db pwd, generate a session secret too. (never share your session secret)
    {
      "development": {
        "_comment": "Never upload this file to Github or any public storage.",
        "dbHost": "localhost",
        "dbUser": "root",
        "dbPassword": <your_db_pwd_here>,
        "dbDatabase": "restapi",
        "session_secret": "93EA130DC0E6DEF5AA47EDA28556EF7C25B01B57F9E876D335FD073318675F86",
        "db": {
          "username": "root",
          "password": <your_db_pwd_here>,
          "database": "restapi",
          "host": "127.0.0.1",
          "logging": false,
          "options": {
            "operatorsAliases": false,
            "dialect": "mysql"
          }
        }
      },
       "production": {
        "_comment": "Place holder..."
      }
    }




Signup/Login (use Website or Postman)

Signup

URL: `/signup`

  • Payload

    Header
    Content-Type: application/x-www-form-urlencoded

    Body (raw)
    email=444%40333.com&password=111&firstname=dalin4&lastname=huang4

Login

URL: `/login`

  • Payload

    Header
    Content-Type: application/x-www-form-urlencoded

    Body (raw)
    email=111%40111.com&password=111

##once login, copy the connect.sid cookie as auth token for testing.







v1 API documentation

NOTE:

  • HTTP Status Code will always be 200 OK
  • However, the status code and error status can be found here:
        {     
            'meta': {
              'error': true,
              'code': 404,
              'msg': 'Error: Can not get Messages!'
            } 
        }
  • Note here: * "error": true for important error.

GET Messages

Returns json data about received messages

  • URL

    /api/v1/messages

  • Method:

    GET

  • Authentication:

    None

  • Search Params

    ?limit=2&order=ASC&offset=15

    • limit (positive int) - max returned records
    • offset (positive int) - skip first xxx records
    • order (ASC or DESC)

  • Error Response:

    • HTTP Status Codes: 200
    • Meta - Codes: 404 
          {     
        "meta": {
            "error": true,
            "code": 404,
            "total": 0,
            "applied_filter": {},
            "msg": "Error: Can not get Messages!"
        } 
    }

  • Success Response:

    • HTTP Status Codes: 200
    • Meta - Codes: 200 
      {
      "meta": {
          "error": false,
          "code": 200,
          "total": 2,
          "applied_filter": {
              "limit": 2,
              "order": "ASC",
              "offset": 15
          },
          "msg": "ok"
      },
      "data": [
          {
              "id": 19,
              "user_id": 1,
              "content": "OK = \"</script><script>alert('W');</script>\"",
              "createdAt": "2018-09-30T00:38:23.000Z",
              "palindrome": null,
              "User": {
                  "first_name": "dalin",
                  "last_name": "huang"
              }
          },
          {
              "id": 22,
              "user_id": 1,
              "content": "abcba",
              "createdAt": "2018-09-30T01:38:03.000Z",
              "palindrome": true,
              "User": {
                  "first_name": "dalin",
                  "last_name": "huang"
              }
          }
      ]
  }

GET One Message

Returns json data about one message

  • URL

    /api/v1/messages/:id

  • Method:

    GET

  • Authentication:

    None

  • URL Params

    Required: id=[integer]

  • Error Response:

    • HTTP Status Codes: 200
    • Meta - Codes: 404 
          {
        "meta": {
            "error": false,
            "code": 404,
            "total": 0,
            "applied_filter": {},
            "msg": "Message does not exsits"
        },
        "data": null
    }

  • Success Response:

    • Code: 200 
      {
      "meta": {
          "error": false,
          "code": 200,
          "total": 1,
          "applied_filter": {},
          "msg": "OK"
      },
      "data": {
          "id": 23,
          "user_id": 1,
          "content": "ab😌😌😌cba",
          "createdAt": "2018-09-30T01:38:22.000Z",
          "palindrome": true,
          "User": {
              "first_name": "dalin",
              "last_name": "huang"
          }
      }
  }

POST Message

Returns json data about created message

  • URL

    /api/v1/messages/:id

  • Method:

    POST Required Header:

    Authorization : s%3A2HnZqBwicujI7LdI7ESMUb8... Content-Type : application/json

    Required Payload:

        {
        "data": {
            "message": "This msg looks <*&(&%$-=_^#@@!> ok?"
        }
    }

  • Authentication:

    Required login

  • URL Params

    Required: id=[integer]

  • Error Response:

    • HTTP Status Codes: 200

    • Meta - Codes: 404 

      {
    "meta": {
        "error": false,
        "code": 404,
        "total": 0,
        "applied_filter": {},
        "msg": "Message does not exsits"
    },
    "data": null
}

    • HTTP Status Codes: 200

    • Meta - Codes: 401 

      {
    "meta": {
        "error": false,
        "code": 401,
        "total": 0,
        "applied_filter": {},
        "msg": "Unauthorized: login is required"
    },
    "data": null
}

    • HTTP Status Codes: 200

    • Meta - Codes: 400

    • Note here: * "error": true because the payload is wrong, * Therefore an important error

      {
    "meta": {
        "error": true,
        "code": 400,
        "msg": "Error: bad request, check your payload or URL!"
    }
}

  • Success Response:

    • HTTP Status Codes: 200
    • Meta - Codes: 201 
      {
      "meta": {
          "error": false,
          "code": 201,
          "total": 1,
          "applied_filter": {},
          "msg": "Created"
      },
      "data": {
          "status": 1,
          "id": 46,
          "user_id": 1,
          "content": "This msg looks <*&(&%$-=_^#@@!> ok?",
          "palindrome": false,
          "updatedAt": "2018-10-01T00:11:12.467Z",
          "createdAt": "2018-10-01T00:11:12.467Z"
      }
  }

DELETE One Message

Returns json data about result of delete one message

  • URL

    /api/v1/messages/:id

  • Method:

    DELETE Required Header:

    Authorization : s%3A2HnZqBwicujI7LdI7ESMUb8...

  • Authentication:

    Login required Is owner of the message required

  • URL Params

    Required: id=[integer]

  • Error Response:

    • HTTP Status Codes: 200

    • Meta - Codes: 400 

      {
    "meta": {
        "error": false,
        "code": 400,
        "total": 0,
        "applied_filter": {},
        "msg": "Error: Message id should be interger and greater than 0"
    },
    "data": null
}

    • HTTP Status Codes: 200

    • Meta - Codes: 404 

      {
    "meta": {
        "error": false,
        "code": 404,
        "total": 0,
        "applied_filter": {},
        "msg": "Message dos not exsits"
    },
    "data": null
}

    • HTTP Status Codes: 200

    • Meta - Codes: 401 

      {
    "meta": {
        "error": false,
        "code": 401,
        "total": 0,
        "applied_filter": {},
        "msg": "Unauthorized: login is required"
    },
    "data": null
}

    • HTTP Status Codes: 200

    • Meta - Codes: 401 

      {
    "meta": {
        "error": false,
        "code": 401,
        "total": 0,
        "applied_filter": {},
        "msg": "Unauthorized"
    },
    "data": null
}

  • Success Response:

    • HTTP Status Codes: 200
    • Meta - Codes: 204 
      {
      "meta": {
          "error": false,
          "code": 204,
          "total": 1,
          "applied_filter": {},
          "msg": "The message was successfully deleted"
      },
      "data": {
          "id": 47,
          "user_id": 1,
          "content": "This msg looks <*&(&%$-=_^#@@!> ok?",
          "createdAt": "2018-10-01T00:16:37.000Z",
          "palindrome": false,
          "User": {
              "first_name": "dalin",
              "last_name": "huang"
          },
          "status": 0,
          "updatedAt": "2018-10-01T00:40:09.102Z"
      }
  }

About

No description or website provided.

Topics

nodejs express

Resources

Readme
Activity

Stars

9 stars

Watchers

2 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages