Skip to content

Latest commit

 

History

History
103 lines (74 loc) · 3.1 KB

README.md

File metadata and controls

103 lines (74 loc) · 3.1 KB
Raw

Blogging Application

Blogging Application

WEB SERVICE : REST A.P.I.

The Blogging Application's REST API is a web-based platform that empowers bloggers and users to share their ideas and perspectives in an interactive way. The API allows users to publish blogs on their personal profiles, complete with image support, which enhances the user experience. The API also enables users to view and search for blogs and blog categories that align with their personal interests, fostering a community-driven platform. Users can also leave comments on published posts, encouraging engagement.

The API uses standard HTTP methods to retrieve, create, update, and delete data, providing a secure and robust way for the Blogging Application to interact with the data, making it easy and safe for users to share their thoughts and ideas. This REST API is an ideal solution for anyone who wants to connect with others and share their ideas through blogging.

Features

  • The API includes functionality for pagination, sorting, and searching of data.
  • The API implements custom exception handling for all exceptions and validations.
  • The API utilizes custom request and response data transfer objects for all HTTP requests.
  • The API's primary objective is to provide a streamlined and user-friendly blogging experience for users.
  • Built on REST Architecture
  • Consumable by clients that support HTTP Protocol
  • Can be integrated with any application that supports REST API
  • Suitable for a wide range of use cases.

Tech Stack

  • JAVA
  • SPRING
  • SPRINGBOOT
  • HIBERNATE
  • MAVEN
  • J.D.B.C
  • MYSQL
  • POSTMAN

Dependencies

  • SPRING DATA JPA
  • SPRING BOOT DEVTOOLS
  • SPRING WEB
  • HIBERNATE
  • MYSQL DRIVER
  • VALIDATION
  • LOMBOK
  • MODEL MAPPER
  • LOGGER

User Functionalities

  • Profile Management

    • Endpoint for Updating User Information
    • Endpoint for Retrieving User Information
    • Endpoint for Deleting User Account

  • Post Management

    • Endpoint for Creating Posts
    • Endpoint for Updating Posts
    • Endpoint for Retrieving Posts
    • Endpoint for Deleting Posts
    • Endpoint for Adding Comments to Posts
    • Endpoint for Updating Post Images
    • Endpoint for Retrieving Posts with Custom Pagination

  • Category Management

    • Endpoint for Creating Categories
    • Endpoint for Updating Categories
    • Endpoint for Retrieving Categories
    • Endpoint for Deleting Categories

  • Searching & Sorting Posts

    • Endpoint for Searching Posts by :
      • Title
      • Date
      • Category
    • Endpoint for Sorting Posts by :
      • Date
      • Popularity

  • User Search

    • Endpoint for Searching Users by :
      • Name

Administrator Functionalities

  • Profile Management

    • Endpoint for Deleting Admin Accounts

  • Post Management

    • Endpoint for Retrieving Posts
    • Endpoint for Deleting Posts

  • Category Management

    • Endpoint for Retrieving Categories
    • Endpoint for Deleting Categories

  • Comment Management

    • Endpoint for Retrieving Comments
    • Endpoint for Deleting Comments