Skip to content

06Sakthivel/Library-Management

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Library Management

Library Management REST API built using Spring Boot + MongoDB

Deployment

To deploy this project

  Use any IDE like Intellij, STS which runs your webapplication locally on your machine 

  base url : http://localhost:8080/api/v1/library

Architecture

Architecture

API Reference

Admin Priviliges

  • Admin can perform all the CRUD operation on books.
  • Admin can view all the users .
  • Admin has the Privilige to delete users .
  • Admin authenticationkey is necessary to perform any CRUD operations.

User Priviliges

Users only have access to view the books in the library

Register as ADMIN/USER

  POST /api/v1/library/register
Body Type Description
User details USER Required. User fields should not be null or empty.

Login

  GET /api/v1/library/login
Body Type Description
Login Credentials USER DETAILS Required. Email and Password. A Unique id will be sent back to the client as response which is used as an authenticationkey to access the books from the library

Logout

  GET /api/v1/library/logout
Body Type Description
Logout Credentials USER DETAILS Required. Email and Password

Access Books from the library

  GET /api/v1/library/books
Headers Type Description
authenticationKey String Returns all books from the library. Authentication key is Required in order to access books from the library

Get Book by Id

  GET /api/v1/library/book/{id}
Pathvariable Type Description
id String Book Id is Required to fetch the book from the library

Get Book by Name

  GET /api/v1/library/book
Parameters Type Description
name String Book Name is Required to fetch the book from the library

Update Book

  GET /api/v1/library/updatebook
Body Type Description
book Book updates the book that matches the primary key (ID)

Remove Book

  GET /api/v1/book/library/book/remove/{id}
Pathvariable Type Description
id Book Book ID is Required to remove the book from the library

Delete User

  GET /api/v1/library/book/user/delete
Parameters Type Description
id String Removes the user with the specified Id

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages