This is a simple RESTful API for managing subscribers built using NODE JS and MongoDB. It allows you to perform CRUD operations (Create, Read, Update, Delete) on subscriber records.
- Node.js and npm (Node Package Manager)
- MongoDB
- Clone the repository:
git clone https://github.com/yourusername/Subscriber-Management-API.git
cd Subscriber-Management-API- Install dependencies:
npm install- Start the server:
npm run devStartThe server will start on http://localhost:3000.
| Methods | Endpoints | Access | Description |
|---|---|---|---|
| GET | /subscribers | Public | Get a list of all subscribers |
| GET | /subscribers/:id | Public | Get details of a specific subscriber by ID |
| POST | /subscribers | Public | Create a new subscriber |
| PATCH | /subscribers/:id | Private | Update details of a specific subscriber by ID |
| DELETE | /subscribers/:id | Private | Delete a subscriber by ID |
- To get all subscribers:
GET http://localhost:3000/subscribers - To get a specific subscriber:
GET http://localhost:3000/subscribers/123where123is the id - To create a new subscriber:
POST http://localhost:3000/subscribers
Body: {
"name": "John Doe",
"subscribedToChannel": "MyChannel"
}- To update a subscriber:
PATCH http://localhost:3000/subscribers/123
Body: {
"name": "Updated Username"
"subscribedToChannel": "Updated Channel"
}- To delete a subscriber:
DELETE http://localhost:3000/subscribers/123
Contributions are welcome! If you have any enhancements, bug fixes, or suggestions, feel free to submit a pull request.