A library book management system API

See Docs of Library-Management-System

POSTMAN Docs here

API Documentation

Base URL for all endpoints https://localhost:7894/

Start MongoDB Service

Run

npm install //Install all Depedencies
npm run start //Starts in localhost:7894

Test API

http://localhost:7894/api-docs

Book Model

Key	Type	Description
_id	ObjectId	Unique ID for the Book
name	String	The Book Name
cupBoardNumber	Integer	The Book's Location
genre	String	The Book genre
_v	Number	Version number of the Book

Book Endpoints

Get Deatils of Books.

Routes

Name	Method	Route
List	GET	/api/books/
Show	GET	/api/books/:id
Create	POST	/api/books/:id
Update	PUT	/api/books/:id/edit
Delete	DELETE	/api/books/:id

Read more

Book List Query

Parameter	Query	Type	Options	Default	Description
Page Number	page	Number	>1	1	Each Page Is Limited to return 10 results, for more results pass page number
Name	name	String	utf-8 string	' '	Key Word of Book Name can be used to search
Genre	genr	String	utf-8 string	' '	Filter by Genre or search by genre
Sort	sort	String	['asc','desc']	asc	Sort Book by CBN
Cup Board Number(CBN)	cbNum	Number	>1	1	Filters Books with Cupboard Number Greater than given
Less Than (CBN)	lte	boolean	[true, false]	false	To get Books less than a particular Number Must be passed with (CBN)

Read More

Admin Endpoints

GUI of Data (in DB),

Library by AdminBro.

Endpoint

GET /admin/

To be called in Browser.

Has Authentication

Creds

Eamil	Password
[email protected]	coding

Login

DashBoard

Show/Edit

Completed Tasks

• RESTfull Api
• CRUD Routes
• Paginated Results
• Filter Routes
• Admin Panel with Authentication
• Postman Requests
• User Model
• JWT Auth
• Config for Deployment

Todo

• Middlewares to Authenticate and Authorize
• Add Tests for User Routes
• Use Case Diagram
• Librarian Seperate Login
• Update Book Model - [ ] History - [ ] Recommendation
• Fine System - [ ] Bills - [ ] Over Dues
• User Type => Student and Teacher
• User Model - [ ] Account Model - [ ] History - [ ] Billing