Library API

Introduction • Installation Guide • API Reference • Credits • License • Contributors

ℹ️Introduction

Library API that you can manage the books and it's users using ASP-NET WEB API. It has 2 roles which are Admin and User.

It uses MS-SQL | EntityFramework on DB side. Authentication and authorization processes are performed using Bearer Token.

Admin Actions	User Actions
`Create, Update and Delete a User`	`Borrow a Book`
`Create, Update, Delete and Return a book`	`Return the Book`
`Get book(s)`	`Get book(s)`
`Get and Delete all auth Logs`	`Get own profile auth Logs`
`Update own profile credentials`	`Update own profile credentials`

💾Installation Guide

To clone and run this application, you'll need Git, ASP NET, MS-SQL and Visual Studio installed on your computer. From your command line:

# Clone this repository
$ git clone https://github.com/Ctere1/LibraryAPI
# Go into the repository
$ cd LibraryAPI

After these steps, you should be able to open the project/solution with Visual Studio, build it and run it from there.

⚡API

See Postman Collection Json for detailed information. Also Swagger Doc included in this project.

Authentication Endpoint

HTTP Verb	Endpoint	Description	Admin Access	User Access
`GET`	`api/Auth/GetToken`	Returns Bearer Token	☑️	☑️

Signup Endpoint

HTTP Verb	Endpoint	Description	Admin Access	User Access
`POST`	`api/Signup`	To create a new User	☑️	☑️

User Endpoints

HTTP Verb	Endpoint	Description	Admin Access	User Access
`GET`	`api/User`	Returns User(s)	☑️	❌
`PUT`	`api/User`	To update a User	☑️	❌
`GET`	`api/User/MyProfile`	Returns user's or admin's profile credentials	☑️	☑️
`POST`	`api/User`	To create a User	☑️	❌
`PUT`	`api/User/AdminProfile`	To update admin profile	☑️	❌
`DELETE`	`api/User`	To delete a user	☑️	❌

Book Endpoints

HTTP Verb	Endpoint	Description	Admin Access	User Access
`GET`	`api/Book`	Returns Book(s)	☑️	☑️
`PUT`	`api/Book`	To update Book	☑️	❌
`GET`	`api/Book/MyBooks`	Returns User's books	❌	☑️
`POST`	`api/Book`	To create a Book	☑️	❌
`PUT`	`api/Book/Return`	To return a Book	☑️	☑️
`PUT`	`api/Book/Borrow`	To borrow a Book	❌	☑️
`DELETE`	`api/Book`	To delete a Book	☑️	❌

Log Endpoints

HTTP Verb	Endpoint	Description	Admin Access	User Access
`GET`	`api/Log`	Returns Log(s)	☑️	☑️
`DELETE`	`api/Log`	To delete a Log	☑️	❌

📃Swagger Doc

When the server is up, it will automatically redirect the web page to Swagger.

👤User Data Example

{
    "id": 2,
    "name": "new",
    "email": "new@gmail.com",
    "password": "1234"
}

📚Book Data Example

{
    "id": 1,
    "name": "new book2",
    "genre": "novel",
    "language": "english",
    "publisherName": "oxford press",
    "authorName": "John",
    "description": "lorem",
    "isActive": false,
    "issuedFrom": "2022-12-13T15:53:18.097",
    "issuedTo": "2022-12-15T00:00:00",
    "borrowedBy": "user@user.com"
}

🧾Log Data Example

{
    "id": 92,
    "user_email": "user@user.com",
    "time": "2022-12-18T20:58:49.993",
    "message": "user@user.com borrowed Book: new book5 via API"
}

🚥Get Token Data Example

{
    "access_token": "9iaB18wzzG6-XRGJrYonDEEaQgMIqMNBO-AfS1gT-MsotDcyFVygpXlnG3asRFSJRPHuHKAUDlkK962XUkXnhrcHgOVMJhuEr05Emxtwf-vYRn_YnvcfdqKqLhbOQloHZiphLNSNSFByuHiRk8mWtWi_jMs",
    "token_type": "bearer",
    "expires_in": 899
}

📝Credits

This software uses the following packages:

Microsoft.AspNet.WebApi
Microsoft.Owin
Swashbuckle
EntityFramework

©License

Copyright (c) 2022 Cemil TAN

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Ctere1/LibraryAPI