Welcome to this incredible Exercise Tracker REST API!
This is an API that will help you keep track of each user exercise session.
- I can create a user by posting form data username to /api/exercise/new-user and returned will be an object with username and _id.
- I can get an array of all users by getting api/exercise/users with the same info as when creating a user.
- I can add an exercise to any user by posting form data userId(_id), description, duration, and optionally date to /api/exercise/add. If no date supplied it will use current date. Returned will be the user object with also with the exercise fields added.
- I can retrieve a full exercise log of any user by getting /api/exercise/log with a parameter of userId(_id). Return will be the user object with added array log and count (total exercise count).
- I can retrieve part of the log of any user by also passing along optional parameters of from & to or limit. (Date format yyyy-mm-dd, limit = int)
- Post and Get users and user´s sessions.
- Get all the information you need about any user´s exercise sessions, like description, duration, and date.
- Search user exercise sessions by user id, you can also specify dates between which to search and limit the number of responses.
- Search for all users.
This is a welcome message from the developer of this API:
I hope you enjoy using this amazing API and I would love for you to tell me
what projects you are working on. Have fun!
This API requires Node.js to run. This API uses MongoDB Atlas, so the database is on the cloud.
Clone the repository and then start the server with:
$ npm startPlease take a look at the dependencies that this API uses.
Superhero API uses:
- Body-Parser - Node.js body parsing middleware.
- Express - fast node.js network app framework [@tjholowaychuk]
- Mongoose - HTML to Markdown converter
- MongoDB Atlas - Cloud-hosted MongoDB service
- node.js - for the backend
And of course, Exercise Tracker REST API itself is open source with a public repository on GitHub.
These are the main routes you may want to use.
| Action | Route |
|---|---|
| Home Page - You can post the data | http://localhost:3000/ |
| New User has been created | http://localhost:3000/api/exercise/new-user |
| New session has been created | http://localhost:3000/api/exercise/add |
| Get all the users | http://localhost:3000/api/exercise/users |
| Get user´s full exercises list | http://localhost:3000/api/exercise/log?userId=USER_ID |
| Get user´s exercises list filtered *1 | http://localhost:3000/api/exercise/log?userId=USER_ID&from=DATE1&to=DATE2&limit=LIMIT_OF_RESPONSES |
(*1) Limit: number of excercises per page (max 50). DATE1: initial date. DATE2: final date. Both dates with format: MM/DD/YYYY Remember that ? and &: means a query is meant to be used.
This was a microservice project for Free Code Camp. You can see the freecodecamp test here
MIT