This is a initializing starting point for making an API.
| Column Name | Data Type | Notes |
|---|---|---|
| _id | ObjectId | Made by MongoDB |
| name | String | Optional in this case |
| completed | Boolean | true or false |
| __v | Number | Made by Mongoose |
| Method | Path | Location | Purpose |
|---|---|---|---|
| GET | /api | app.js | Welcome to API |
| GET | /api/examples | example.js | Get all examples |
| GET | /api/examples/:id | example.js | Get one example |
| POST | /api/examples | example.js | Create an example |
| PUT | /api/examples/:id | example.js | Update an example |
| DELETE | /api/examples/:id | example.js | Delete an example |
Detailed info for serialized examples
- Get all examples : GET /examples
- Get one example : GET /examples/:id
- Create a capsule : POST /examples
- Update a capsule : PUT /examples/:id
- Delete a capsule : DELETE /examples/:id
| Column Name | Data Type | Notes |
|---|---|---|
| id | ObjectId | Made by MongoDB |
| name | String | required |
| String | required | |
| password | String | required (hash) |
| date | Date | Set default date |
| __v | Number | Made by Mongoose |
| Method | Path | Location | Purpose |
|---|---|---|---|
| GET | /api/users/test | user.js | Test route for users, no user returned |
| POST | /api/users/register | user.js | Create a new user and add to DB |
| POST | /api/users/login | user.js | Logs user in via credentials, returns user |
| GET | /api/users/profile | user.js | Protected route, need token to access |
Detailed info for serialized examples
- Test user routes : GET /users/test
- Create a user : POST /users/register
- Login a user : POST /users/login
- Return user data (must login beforehand and use token) : GET /users/profile
- Install
axios
npm install axios