Ebazhanov/rest-api-quick

REST API example

This repository contains code demonstrating Rest API with GET, POST, PATCH, DELETE requests samples

GET request to get all subscribers

$ http://localhost:3002/subscribers/

router.get('/', async (req, res) => {
    try {
        const subscribers = await Subscriber.find();
        res.json(subscribers)
    } catch (err) {
        res.status(500).json({message: err.message})
    }
});

GET request to get subscriber by /id

$ http://localhost:3002/subscribers/5e5fcff1dc53dec90f09512d

router.get('/:id', getSubscriber, (req, res) => {
    res.json(res.subscriber)
});

POST request to create one subscriber by /id

POST http://localhost:3002/subscribers
Content-Type: application/json

{
  "name": "Amazing Person",
  "subscribedToChannel": "Web Dev test"
}

router.post('/', async (req, res) => {
    const subscriber = new Subscriber({
        name: req.body.name,
        subscribedToChannel: req.body.subscribedToChannel
    });
    try {
        const newSubscriber = await subscriber.save();
        res.status(201).json(newSubscriber)
    } catch (err) {
        res.status(400).json({message: err.message})
    }
});

UPDATE request to update one subscriber by /id

$ http://localhost:3002/subscribers/id

router.patch('/:id', getSubscriber, async (req, res) => {
    if (req.body.name != null) {
        res.subscriber.name = req.body.name
    }
    if (req.body.subscribedToChannel != null) {
        res.subscriber.subscribedToChannel = req.body.subscribedToChannel
    }
    try {
        const updatedSubscriber = await res.subscriber.save();
        res.json(updatedSubscriber)
    } catch (err) {
        res.status(400).json({message: err.message})
    }
});

DELETE request to delete one subscriber by /id

$ http://localhost:3002/subscribers/id

router.delete('/:id', getSubscriber, async (req, res) => {
    try {
        await res.subscriber.remove();
        res.json({message: 'Deleted Subscriber'})
    } catch (err) {
        res.status(500).json({message: err.message})
    }
});

How to start the project

• Install MongoDB
• Run it locally $ brew services start mongodb-community
• Lunch server $ yarn start

Usage

• To easily run any of request, you can use route.rest