Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devenock/expressrestapi
A RESTful api built using NodeJS and ExpressJS.
https://github.com/devenock/expressrestapi
axios expressjs mongodb nodejs
Last synced: 6 days ago
JSON representation
A RESTful api built using NodeJS and ExpressJS.
- Host: GitHub
- URL: https://github.com/devenock/expressrestapi
- Owner: devenock
- License: mit
- Created: 2022-06-15T23:13:10.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-14T09:43:27.000Z (about 1 year ago)
- Last Synced: 2024-12-10T20:40:29.257Z (14 days ago)
- Topics: axios, expressjs, mongodb, nodejs
- Language: JavaScript
- Homepage:
- Size: 204 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NodeJS Books RESTFUL api
[]()
A minimal, secure RESTFUL api for NodeJS. This project is basically a books api that demonstrates all the CRUD operations.
# Installation
- Clone the repo by using `git clone`.
- Run `npm install` on the cloned directory.
- Add a .evn file and include your mongoDB collection string to connect to your MongoDB instance.
- Test your APIs on Postman to see if all the endpoints are working as required.
# Steps to add new API
- Copy the template model (model/bookModel.js) to a new file in the **models** folder and make the modifications outlined in the header.
`copy model/bookModel.js --> model/bookModel.js`
- Copy the template controller (controllers/RecipeController.js) to a new file in the **controllers** folder and make the modifications outlined in the header.
`copy controllers/bookController.js --> controllers/customController.js`
```
const booksController = require('../controllers/booksController');
const customController = require('../controllers/customController');
```
- You can add a test route to server.js underneath the existing routes, like so:
```
app.use('/api/v1/books', bookRouter);
app.use('/api/v1/books', customRouter);
```
# Running the software
- `node app.js` for simple setups.
- I would recommend looking at [the pm2 module](https://www.npmjs.com/package/pm2) for running on a production server.
# API Endpoints
### GET ALL BOOKS
```
GET: http://localhost:5050/api/v1/books
```
### GET A SINGLE BOOK
```
GET: http://localhost:5050/api/v1/book/:id
```
### UPDATE A BOOK
```
POST: http://localhost:5050/api/v1/book/update/:id
```
### DELETE A BOOK
```
DELETE: http://localhost:5050/api/v1/book/:id
```
### Project Tests
For this project, we will implement the tests using **Mocha**, **Chai** and **Sinon**.
## Show your support
Give a ⭐️ if you like this project!
## License
[](http://badges.mit-license.org)
- **[MIT license](http://opensource.org/licenses/mit-license.php)**