[Complete] Test Backend Submission

[ezio-hub]

work in process

• add koa and mongo
• add first api point
• add apidoc

[ezio-hub]

The basic requirments is complete, live api doc, http://120.26.39.188:9090/apidoc/

This PR includes:

• user model base on mongoldb
• apidoc
• Create user api /http://120.26.39.188:9090/apidoc/, all fields are required, return user model and jwt token
• Update user api. user can only update his data, needs jwt authentication, PUT api needs all fields, Patch api all fields are optional
• Delete user api. user can only delete himself, needs jwt authentication
• GET user and Get user list api. return user list, also support fuzzy search and pagination
• Test case to test all the apis above
• travis CI
• setup lint by standard for lint

implementation details:

• use config package to store/use config files base on NODE_ENV
• use apidoc to generate online document base on the comment lines on router files
• Put general apidoc in the routers/doc.js file
• use Joi to validate form data, throw 400 if there's errors
• write global error handler if app/app.js, all error response should have the same structure, {errorCode,message}
• write custom error, and provide a panic function to throw this kind of error. can be used on router/service level
• put model common fields and function in app/models/base.js , every module should base on it
• write toData function in app/model/base.js to return the data exact match the user model defined in README
• handle form data in router level and process business logic/db in service level

how to run the code

run server npm run dev

watch api doc npm install apidoc -g npm run watch_apidoc it will generate apidoc files when your apidoc comments changes, you can go to localhost:9090/apidoc/ and test your api in realtime

This PR not includes

• the followers/following friends features, the friend can be like this Id,userId,friendId,createdAt get followers will query by friends.query({friendId:userId}) get following will query by friends.query({userId:userId}) The api will be
  follow POST /api/v1/users/follow get Followers Get /api/v1/users/followers get following Get /api/v1/users/following unfollow DELETE api/v1/users/followers/:id

• geo search I will create a location field in user document like this

  location: {
    type: "Point",
    coordinates: [-73.856077, 40.848447]
  }

  and update all users CRUD api. add new api GET /api/v1/users/nearby?query=link and build the query like this

  db.users.find(
  {
   location:
     { $near :
        {
          $geometry: { type: "Point",  coordinates: [ -73.9667, 40.78 ] },
          $minDistance: 1000,
          $maxDistance: 5000
        }
     }
  }
  )

[ezio-hub]

test setps

create user

http://120.26.39.188:9090/apidoc/#api-users-createUser id is 5f1e2f194d88671d9b0c7ade token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVmMWUyZjE5NGQ4ODY3MWQ5YjBjN2FkZSIsImlhdCI6MTU5NTgxMzY1NywiZXhwIjoxNTk5NDEzNjU3fQ.IT32WV21rhcx_2L6PpoMwnHqN_LIqpeMzdRIwkV_JeI

update user's name

http://120.26.39.188:9090/apidoc/#api-users-partiallyUpdateUser

update all user's fields

http://120.26.39.188:9090/apidoc/#api-users-fullyUpdateUser

get user from list by search