Register, login, and access user information for macro calculator application
\nTo contribute or utiilize this project, clone and download the git repository. Run npm install to download the necessary dependencies. Run npm run server in the command line to start the server on localhost:5000.
Leverage /auth/register or /auth/login to authenticate with the app and receive a token for accessing the user information routes.
\n200 OK201 Created400 Bad Request\n -The server could not understand the request due to invalid syntax\n -The most likely cause is an improper request body\n-401 Unauthorized\n -No authentication header was provided with the request404 Not found\n -The server could not find the requested source500 Internal Server Error\n -The server has encountered a situation it doesn't know how to handleNone
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Vision","slug":"vision"},{"content":"About","slug":"about"},{"content":"Authentication","slug":"authentication"},{"content":"HTTP Status Codes","slug":"http-status-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"9286218","collectionId":"c9d59eae-a046-478c-a8c1-fb6087af232c","publishedId":"SW7Z2nhd","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-19T05:58:54.000Z"},"item":[{"name":"https://bw-macro-calculator.herokuapp.com/auth/register","id":"59fb0681-fab6-48ef-a823-005915e765d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"authorization","value":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjoyMiwidXNlcm5hbWUiOiJ0ZXN0aW5nIiwicGFzc3dvcmQiOiIkMmEkMTAkSi9uUlpWaW91ZmhUU05udmJ3dmdtLmZKeWlXMHBtbDhNeTJvZllnekI1V1dLMTloR2taTHkiLCJmdWxsbmFtZSI6InRlc3RpbmcifSwiaWF0IjoxNTc0MjA5NzE3LCJleHAiOjE1NzQyMzg1MTd9.1sziAniMJWnHnAcLPd5wue4CxuB5XsnD_zOacSykq7Q","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"fullname\": \"Steven J\",\n\t\"username\": \"stevej\",\n\t\"password\": \"password\"\n}","options":{"raw":{"language":"json"}}},"url":"https://bw-macro-calculator.herokuapp.com/auth/login","description":"Register and authenticate a new user
\nExample request body: \n{ \"fullname\": \"jane doe\", \"username\": \"jane\", \"password\": 'password' }
Subsequent login not required. Returns an Object with user and token key:value paris. Example response body:
\n{ \"user_id\": 32, \"fullname\": \"jane doe\", \"username\": \"jane\", \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjozMiwidXNlcm5hbWUiOiJkb20yIiwicGFzc3dvcmQiOiIkMmEkMTAkakFXSGxudjZ4Q1licTJidUVZaDBxZXpkYXZvbE95S3BWUmdIbGM2R21iam9jNnpXeWlQREsiLCJmdWxsbmFtZSI6InRlc3QifSwiaWF0IjoxNTc0MjEzMzQ4LCJleHAiOjE1NzQyNDIxNDh9.heeTsB275Eng6WMc1nHzYf06xXww6Bl3yqmPjtK8mRk\" }
REQUIRED fields: fullname,username, password
Login with a registered account
\nReturns an Object with user and token key:value paris.\nExample request body:\n`\n{
\n\"username\": \"jane\",\n\"password\": \"password\"\n}\n`
\nExample response boody:
\n{ \"user_id\": 32, \"fullname\": \"jane doe\", \"username\": \"jane\", \"token\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyIjp7ImlkIjozMiwidXNlcm5hbWUiOiJkb20yIiwicGFzc3dvcmQiOiIkMmEkMTAkakFXSGxudjZ4Q1licTJidUVZaDBxZXpkYXZvbE95S3BWUmdIbGM2R21iam9jNnpXeWlQREsiLCJmdWxsbmFtZSI6InRlc3QifSwiaWF0IjoxNTc0MjEzNDExLCJleHAiOjE1NzQyNDIyMTF9.fIRHVNQzQaYVc0iMbLWgzg2gBiJKRY0Yjep1eX7erWE\" }
REQUIRED field username, password
Create a new uesr information object
\nRequires authorization.
\nreq.header.authorization = token;
\nExample request body:
\n{ \"birthdate_day\": 10, \"birthdate_month\": 2, \"birthdate_year\": 2000, \"gender\": \"female\", \"height\": \"69\", \"weight\": \"145\", \"activity_factor\": \"1.9\", \"meals_per_day\": 3, \"snacks_per_day\": 0, \"goal_multiplier\": \"1.1\" }
REQUIRED fields: birthdate_day, birthdate_month, birthdate_year,gender, height, weight, activity_factor, meals_per_day, snacks_per_day, goal_multiplier
Returns the new user information. Example response body:
\n{ \"id\": 1 \"user_id\": 1, \"birthdate_day\": 10, \"birthdate_month\": 2, \"birthdate_year\": 2000, \"gender\": \"female\", \"height\": \"69\", \"weight\": \"145\", \"activity_factor\": \"1.9\", \"meals_per_day\": 3, \"snacks_per_day\": 0, \"goal_multiplier\": \"1.1\" }
Get a user information object by ID
\nRequires authorization.
\nreq.headers.authorization = token;
\nReturn the user information object:
\n{ \"id\": 4, \"user_id\": 32, \"birthdate_day\": 12, \"birthdate_month\": 6, \"birthdate_year\": 1965, \"gender\": \"male\", \"height\": 70, \"weight\": 135, \"activity_factor\": 1.725, \"meals_per_day\": 3, \"snacks_per_day\": 0, \"goal_multiplier\": 1 }
Edit a user information object by ID.
\nRequires authorization.
\n","urlObject":{"protocol":"https","path":["info",":id"],"host":["bw-macro-calculator","herokuapp","com"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"22dc01e2-6b6f-49c2-b8e6-1d2cd0414611","name":"Default","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://bw-macro-calculator.herokuapp.com/info/:id","protocol":"https","host":["bw-macro-calculator","herokuapp","com"],"path":["info",":id"],"variable":[{"key":"id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8c259de5-54d0-4609-bf12-39faa772f4f4"},{"name":"https://bw-macro-calculator.herokuapp.com/info/:id","id":"22b8eb8a-7065-4f3c-9cc1-bdaae2b708f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://bw-macro-calculator.herokuapp.com/info/:id","description":"Delete user information object by ID.
\nRequires authorization.
\n","urlObject":{"protocol":"https","path":["info",":id"],"host":["bw-macro-calculator","herokuapp","com"],"query":[],"variable":[{"type":"any","key":"id"}]}},"response":[{"id":"2bb2933f-8751-4dc8-b4d9-5ab2ee62d9a6","name":"Default","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://bw-macro-calculator.herokuapp.com/info/:id","protocol":"https","host":["bw-macro-calculator","herokuapp","com"],"path":["info",":id"],"variable":[{"key":"id"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"22b8eb8a-7065-4f3c-9cc1-bdaae2b708f6"},{"name":"https://bw-macro-calculator.herokuapp.com/info/all","id":"1e9a3540-b61a-437c-a0a5-ea5c53d51360","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://bw-macro-calculator.herokuapp.com/info","description":"Testing endpoint that retrieves all user informations
\n","urlObject":{"protocol":"https","path":["info"],"host":["bw-macro-calculator","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"a683d81f-3b59-4492-b09c-1f2c6e083dbe","name":"Default","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://bw-macro-calculator.herokuapp.com/info"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"1e9a3540-b61a-437c-a0a5-ea5c53d51360"}],"event":[{"listen":"prerequest","script":{"id":"d401a806-dc0d-457f-9fb7-da4d39ff4e30","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"53133627-d70e-4316-aa53-c218e3f2f6ab","type":"text/javascript","exec":[""]}}]}