https://github.com/anqorithm/liprestfulapi

This is a RESTful api for library app developed using express js and MySQL for the database using sequelize ORM. it contains JWT to secure some endpoints with access token, and centralized error handler as a middleware. It uses express-validator to validate body request.
https://github.com/anqorithm/liprestfulapi

express-js node-js restful-api sequelize

Last synced: 7 days ago
JSON representation

This is a RESTful api for library app developed using express js and MySQL for the database using sequelize ORM. it contains JWT to secure some endpoints with access token, and centralized error handler as a middleware. It uses express-validator to validate body request.

• Host: GitHub
• URL: https://github.com/anqorithm/liprestfulapi
• Owner: anqorithm
• Created: 2021-08-21T00:00:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-07T21:41:22.000Z (about 4 years ago)
• Last Synced: 2025-08-16T07:43:06.524Z (5 months ago)
• Topics: express-js, node-js, restful-api, sequelize
• Language: JavaScript
• Homepage:
• Size: 517 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Library_app_RESTful_api

This is a RESTful api for library app developed using express js and MySQL for the database using sequelize ORM. it contains JWT to secure some endpoints with access token, and centralized error handler as a middleware. It uses express-validator to validate body request. This project is quite scalable. I have tried to use best MVC architecture. However, there is no Views in this project.

## status: incomplete ❌

## Built with

1. Express.js - Minimalist backend framework

2. Node.js - JavaScript runtime

3. Sequelize - Promise-based Node.js ORM for MySQL database

## .env.example

Before running the app you should fill these fields with your own credentials:

```

PORT=

HOST=

NODE_ENV=

DB_HOST=

DB_USERNAME=

DB_PASSWORD=

DB_DATABASE=

DIALECT=

LOGGING=

JWT_KEY=

```

## How to use

You should have NodeJS & MySQL server, (e.g, XAMPP or WampServer) installed in your OS

```

$ npm i

$ npm run dev // for development env

$ npm start // for production env

```

## Endpoints

All endpoints are tested by Postman, you can use either Postman/Insomnia to test this restful api.

| Method                                | Endpoint                            |

| ------------------------------------- | ----------------------------------- |

| GET fetchAllBooksByAuthorId           | /api/v1/authors/:id/books           |

| GET fetchAllAuthors                   | /api/v1/authors                     |

| GET fetchAuthorById                   | /api/v1/authors/:id                 |

| PUT updateAuthorById                  | /api/v1/authors/:id                 |

| DELETE deleteAuthorById               | /api/v1/authors:/id                 |

| POST createBook                       | /api/v1/books                       |

| POST addBookToPublisher               | /api/v1/books/add-publisher         |

| GET fetchAllBooks                     | /api/v1/books                       |

| GET fetchBookById                     | /api/v1/books/:id                   |

| GET fetchAllPublishersByBookId        | /api/v1/books/:id/publishers        |

| PUT updateBookById                    | /api/v1/books/:id                   |

| DELETE deleteBookById                 | /api/v1/books:/id                   |

| POST register                         | /api/v1/users/register              |

| POST login                            | /api/v1/user/login                  |

| GET fetchAllUsers                     | /api/v1/users/                      |

| GET fetchUserById                     | /api/v1/users/:id                   |

| DELETE deleteUserById                 | /api/v1/users/:id                   |

| PUT updateUserById                    | /api/v1/users/:id                   |

| POST createAuthor                     | /api/v1/publisher/                  |

| POST createPublisher                  | /api/v1/publisher/                  |

| POST addPublisherToBook               | /api/v1/publisher/add-book          |

| GET fetchAllBooksByAuthorId           | /api/v1/publisher/:id               |

| GET fetchAllAuthors                   | /api/v1/publisher/                  |

| GET fetchUserById                     | /api/v1/publisher/:id               |

| DELETE deleteAuthorById               | /api/v1/publisher/:id               |

| GET fetchAllBorrowers                 | /api/v1/borrowers/                  |

| GET fetchBorrowerById                 | /api/v1/borrowers/:id               |

| GET fetchAllBorrowedBooksByBorrowerId | /api/v1/borrowers/:id/borrowed-book |

| POST createBorrower                   | /api/v1/borrowers/                  |

| UPDATE updateBorrowerById             | /api/v1/borrowers/:id               |

| GET fetchAllBorrowedBooks             | /api/v1/borrowed-books/             |

| GET fetchAllBorrowedBookById          | /api/v1/borrowed-books/:id          |

| POST createBorrowedBook               | /api/v1/borrowed-books/             |

| UPDATE updateBorrowedBookById         | /api/v1/borrowed-books/:id          |

| DELETE deleteBorrowedBookById         | /api/v1/borrowed-books/:id          |

## Routes documentation

```js

/**

 * @prefix api/v1/authors

 * @route authorRouter

 * @controller authorController

 * @public endpoints [fetchAllBooksByAuthorId, fetchAllAuthors, fetchAuthorById]

 * @private endpoints [createAuthor, updateAuthorById, deleteAuthorById]

 */

router.post(

  '/',

  accessTokenMiddleware,

  bodyValidatorMiddleware('createAuthor'),

  authorController.createAuthor

);

router.get('/:id/books', authorController.fetchAllBooksByAuthorId);

router.get('/', authorController.fetchAllAuthors);

router.get('/:id', authorController.fetchAuthorById);

router.put('/:id', accessTokenMiddleware, authorController.updateAuthorById);

router.delete('/:id', accessTokenMiddleware, authorController.deleteAuthorById);

/**

 * @prefix api/v1/books

 * @route bookRouter

 * @controller bookController

 * @public endpoints [fetchAllBooks, fetchBookById]

 * @private endpoints [createBook, updateBookById, deleteBookById]

 */

router.post(

  '/',

  accessTokenMiddleware,

  bodyValidatorMiddleware('createBook'),

  bookController.createBook

);

router.post(

  '/add-author',

  accessTokenMiddleware,

  bookController.addBookToPublisher

);

router.get('/', bookController.fetchAllBooks);

router.get('/:id', bookController.fetchBookById);

router.get('/:id/publishers', bookController.fetchAllPublishersByBookId);

router.put(

  '/:id',

  accessTokenMiddleware,

  bodyValidatorMiddleware('updateBookById'),

  bookController.updateBookById

);

router.delete('/:id', accessTokenMiddleware, bookController.deleteBookById);

/**

 * @prefix api/v1/users

 * @route userRouter

 * @controller userController

 * @public endpoints [register, login, fetchAllUsers, fetchUserById]

 * @private endpoints [deleteUserById, updateUserById]

 */

router.post(

  '/register',

  bodyValidatorMiddleware('register'),

  userController.register

);

router.post('/login', bodyValidatorMiddleware('login'), userController.login);

router.get('/', userController.fetchAllUsers);

router.get('/:id', userController.fetchUserById);

router.delete('/:id', accessTokenMiddleware, userController.deleteUserById);

router.put(

  '/:id',

  accessTokenMiddleware,

  bodyValidatorMiddleware('updateUserById'),

  userController.updateUserById

);

/**

 * @prefix api/v1/publisher

 * @route publisherRouter

 * @controller publisherController

 * @public endpoints [createPublisher, fetchAllPublishers, fetchAllBooksByPublisherId, fetchPublisherById]

 * @private endpoints [addPublisherToBook, updatePublisherById, deletePublisherById]

 */

router.post(

  '/',

  bodyValidatorMiddleware('createPublisher'),

  publisherController.createPublisher

);

router.post(

  '/add-book',

  accessTokenMiddleware,

  publisherController.addPublisherToBook

);

router.get('/', publisherController.fetchAllPublishers);

router.get('/:id', publisherController.fetchPublisherById);

router.get('/:id/books', publisherController.fetchAllBooksByPublisherId);

router.put(

  '/:id',

  accessTokenMiddleware,

  bodyValidatorMiddleware('updatePublisherById'),

  publisherController.updatePublisherById

);

router.delete(

  '/:id',

  accessTokenMiddleware,

  publisherController.deletePublisherById

);

/**

 * @prefix api/v1/borrowers

 * @route borrowerRouter

 * @controller borrowerController

 * @public endpoints [fetchAllBorrowers, fetchBorrowerById, fetchAllBorrowedBooksByBorrowerId, fetchPublisherById]

 * @private endpoints [createBorrower, updateBorrowerById, deleteBorrowerById]

 */

router.get('/', borrowerController.fetchAllBorrowers);

router.get('/:id', borrowerController.fetchBorrowerById);

router.get(

  '/:id/borrowed-books',

  borrowerController.fetchAllBorrowedBooksByBorrowerId

);

router.post(

  '/',

  accessTokenMiddleware,

  bodyValidatorMiddleware('createBorrower'),

  borrowerController.createBorrower

);

router.put(

  '/:id',

  accessTokenMiddleware,

  borrowerController.updateBorrowerById

);

router.delete(

  '/:id',

  accessTokenMiddleware,

  bodyValidatorMiddleware('updateBorrower'),

  borrowerController.deleteBorrowerById

);

/**

 * @prefix api/v1/borrowed-books

 * @route borrowedBookRouter

 * @controller borrowerBookController

 * @public endpoints [fetchAllBorrowedBooks, fetchAllBorrowedBookById]

 * @private endpoints [createBorrowedBook, updateBorrowedBook, deleteBorrowedBook]

 */

router.get('/', borrowedBookController.fetchAllBorrowedBooks);

router.get('/:id', borrowedBookController.fetchAllBorrowedBookById);

router.post(

  '/',

  accessTokenMiddleware,

  bodyValidatorMiddleware('createBorrowedBook'),

  borrowedBookController.createBorrowedBook

);

router.put(

  '/:id',

  accessTokenMiddleware,

  bodyValidatorMiddleware('updateBorrowedBook'),

  borrowedBookController.updateBorrowedBook

);

router.delete(

  '/:id',

  accessTokenMiddleware,

  borrowedBookController.deleteBorrowedBook

);

```

## License

This RESTful api under MIT licence you can use it for free

Made with 💙 by 04bdull4h