Giter Club home page Giter Club logo

hamed-hasan / backend-book-catelog Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 179 KB

๐Ÿ“š Book Catalog Backend: Powering a seamless book management system. Custom auth, roles, and APIs for CRUD operations. Dive into the world of books! ๐Ÿš€ #Backend #BookCatalog #APIs

Home Page: https://catelog-book.vercel.app/api/v1

Shell 0.16% TypeScript 99.84%
express jwt-authentication nodejs postgresql prisma role-authentication typescript custom-authentication

backend-book-catelog's Introduction

Book Catalog Backend

This robust backend API powers the Book Catalog application, implementing custom authentication and role-based authorization for managing users, categories, books, and orders.

Live Link

Live Link to the API

ERD Diagram

Token-Based Authentication: To ensure data security and access control, certain APIs require an authentication token with the appropriate role for CRUD operations, while others are publicly accessible.

Role-Based Authorization: For CRUD actions and sensitive operations, please provide a valid authentication token with the correct role to access these APIs securely.

Application Routes

User

  • POST https://catelog-book.vercel.app/api/v1/auth/signup: Create a new user.
  • GET https://catelog-book.vercel.app/api/v1/users: Get a list of all users.
  • GET https://catelog-book.vercel.app/api/v1/users/:id: Get a single user by ID. Replace :id with a valid user ID from the database.
  • PATCH https://catelog-book.vercel.app/api/v1/users/:id: Update a user's information by ID. Replace :id with a valid user ID from the database.
  • DELETE https://catelog-book.vercel.app/api/v1/users/:id: Delete a user by ID. Replace :id with a valid user ID from the database.
  • GET https://catelog-book.vercel.app/api/v1/profile: Get the profile information of the currently authenticated user.

Category

  • POST https://catelog-book.vercel.app/api/v1/categories/create-category: Create a new category.
  • GET https://catelog-book.vercel.app/api/v1/categories: Get a list of all categories.
  • GET https://catelog-book.vercel.app/api/v1/categories/:id: Get a single category by ID. Replace :id with a valid category ID from the database.
  • PATCH https://catelog-book.vercel.app/api/v1/categories/:id: Update a category by ID. Replace :id with a valid category ID from the database.
  • DELETE https://catelog-book.vercel.app/api/v1/categories/:id: Delete a category by ID. Replace :id with a valid category ID from the database.

Books

  • POST https://catelog-book.vercel.app/api/v1/books/create-book: Create a new book.
  • GET https://catelog-book.vercel.app/api/v1/books: Get a list of all books.
  • GET https://catelog-book.vercel.app/api/v1/books/:categoryId/category: Get all books within a specific category. Replace :categoryId with a valid category ID from the database.
  • GET https://catelog-book.vercel.app/api/v1/books/:id: Get a single book by ID. Replace :id with a valid book ID from the database.
  • PATCH https://catelog-book.vercel.app/api/v1/books/:id: Update a book by ID. Replace :id with a valid book ID from the database.
  • DELETE https://catelog-book.vercel.app/api/v1/books/:id: Delete a book by ID. Replace :id with a valid book ID from the database.

Orders

  • POST https://catelog-book.vercel.app/api/v1/orders/create-order: Create a new order.
  • GET https://catelog-book.vercel.app/api/v1/orders: Get a list of all orders.
  • GET https://catelog-book.vercel.app/api/v1/orders/:orderId: Get a single order by order ID. Replace :orderId with a valid order ID from the database.

profile

  • GET https://catelog-book.vercel.app/api/v1/profile: Get a single profile by profile ID. Replace :profileId with a valid profile ID from the database.

API Documentation (Postman)

Feel free to use these routes to interact with the Book Catalog Backend API. Make requests to the appropriate endpoints to manage users, categories, books, and orders.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.