hcherewaty/API-Server

LAB

API Project

Author: Becca Lee, Heather Cherewaty, Jared Pattison

Links and Resources

• repo
• travis
• heroku

Documentation

• swagger
• jsdoc

Modules

index.js

Setup

.env requirements

• PORT - Defined in ENV.
• MONGODB_URI - Defined in ENV.
• SECRET - Defined in ENV.

Exported Values and Methods

• Connection to server established from index.js.
• New users are created with generated tokens on router.js.
• Returning users sign with router.js.
• Routes to model files are established in v1.js.
• New models to be created should be defined in models folder with accompanying schema. Both files should be exported.
• New models are created in model-finder.js.

Running the app

• npm start
• Endpoint (get): /api/v1/teams
  • Returns stored teams in json.
• Endpoint(get): /api/v1/players
  • Returns stored players.
• Endpoint (post): /api/v1/teams
  • Returns created team in json.
• Endpoint(post): /api/v1/players
  • Returns created player in json.
• Endpoint (get): /api/v1/teams/:id
  • Returns team by id in json.
• Endpoint(get): /api/v1/players/:id
  • Returns player by id in json.
• Endpoint (put): /api/v1/teams/:id
  • Updates team by id in json.
• Endpoint(put): /api/v1/players/:id
  • Updates player by id in json.
• Endpoint (delete): /api/v1/teams/:id
  • Deletes team by id in json.
• Endpoint (delete): /api/v1/players/:id
  • Deletes player by id in json.
• Endpoint: /signup
  • Returns new signed up user in json and a token.
• Endpoint: /signin
  • Returns signed in user by id in json and a token.
• Endpoint: /newrole
  • Returns a newly assigned role in json.
• Endpoint: /key
  • Returns a generated key in json.

Tests

• npm test (runs unit tests)
• npm run lint (runs linter tests)
• When handleGetAll is called on teams or players, we expect all teams and players to show, respectively..
• When handlePost is called, we expect a new team or player to be created.
• When handleGetOne is called, we expect the respective team or player to be called by id.
• When handlePut is called, we expect the respective team or player to be updated by id.
• When handleDelete is called, we expect the respective team or player to be deleted by id.
• When /signup is hit, we expect a new user to be created when required files are provided.
• When /signin is hit, we expect a new user to be signed in when required credentials are provided.
• When /newrole is hit, we expect a new role to be created when required files are provided.
• When /key is hit, we expect a new key to be created when required files are provided.