Overview

This documentation describes the REST API for a blog platform that allows users to create, read, update, and delete blog posts, comments, categories, and tags. The API also includes authentication features and like functionality for posts. Yeah!! Yeah!! There is more to implement but here it is for now🫡

Base URL

The base URL for all API endpoints is:

<http://localhost:8080>

Authentication

Authentication is required for most endpoints. Users can register and login to obtain authentication credentials.

Register a new user

POST /api/v1/auth/register

Request Body:

{
  "name": "string",
  "email": "string",
  "password": "string"
}

Response:

{
  "name": "string",
  "email": "string",
  "message": "string",
  "registeredAt": "string (date-time)"
}

Login

POST /api/v1/auth/login

Request Body: