The Blog REST API With Node.js
I built this repo for fun and to learn how to make a rest api and server
The different things you can do with this server:
- Controllers - deals with database read/write operations and logic.
- Models - define schemas of objects in collections the database.
- Routes - defines the API routing for controller functions.
- Middlewares - helper files, utils and methods. Basically anything that isn't done by a controller.
Start the server with nodemon: npm start. Currently the default port for the server is 5000 and this can be set in the .env. This is to prevent clashes when running the server and clients in dev locally.for database i use mongodb and you can download and install it also you can download and install MongoDB Compass. Compass is a free interactive tool for querying, optimizing, and analyzing your MongoDB data. Get key insights, drag and drop to build pipelines, and more.
sudo fuser -n tcp -k 5000
- bcryptjs: 2.4.3
- dotenv : ^16.3.1
- express: ^4.18.2
- express-validator: ^7.0.1
- jsonwebtoken: ^9.0.
- mongoose: ^7.4.2
- nodemon: 3.0.1
Using .env file to store secret variables in software applications is a good common practice in software development. These variables can be database credentials, urls, ip addresses or hosts, secret keys for third party integrations etc.Since this file contains secret variables, we don't push it to git/github so remember to include .env file in your .gitignore file under your project root directory.
| Path | Method | Description |
|---|---|---|
| /api/v1/users/ | GET | Get all users |
| /api/v1/users/login | POST | User Login |
| /api/v1/users/signup | POST | User Signup |
| Path | Method | Description |
|---|---|---|
| //api/v1/posts/ | POST | Add New Post |
| /api/v1/posts/:pid | DELETE | Delete Post by Post Id |
| Path | Method | Description |
|---|---|---|
| /api/v1/comments/getAllComments | Method | Description |
| /api/v1/comments/:pid | GET | Get All Comments |
| /api/v1/comments/:cid | DELETE | Delete Comments by Comment Id |
!!! Project still in progress !!!