# Blogging App API Structure This document outlines the required APIs for a simple blogging platform, focusing on authentication, post management, and user management. All endpoints should use DTOs for data transfer and return responses in the specified format. Use an H2 database and provided utility classes. --- ## 1. User Registration ### Endpoint ``` POST /register ``` ### Description Register a new user. ### Input (Form Parameters) - `fullName` (String) - `email` (String) - `password` (String) ### Request Example ```json { "fullName": "John Doe", "email": "john@example.com", "password": "mypassword" } ``` ### DTO Example ```java public class UserRegisterDTO { private String fullName; private String email; private String password; } ``` --- ## 2. User Login ### Endpoint ``` POST /login ``` ### Description Authenticate user and return a JWT. ### Input (Form Parameters) - `email` (String) - `password` (String) ### Response ```json { "data": "<JWT_TOKEN>" } ``` - Use the `hawk` class from the `util` package to generate JWTs. - Return all responses via a `genericSuccess(Object data)` method. --- ## 3. Post Management (Authenticated) All `/api/*` endpoints require JWT authentication via the `Authorization: Bearer <token>` header. ### 3.1 Publish Post #### Endpoint ``` POST /api/publish ``` #### Description Publish a new blog post. #### Input (DTO) ```java public class PostDTO { private String title; private String content; // Add other fields as needed } ``` --- ### 3.2 Fetch All Posts #### Endpoint ``` GET /api/getPost ``` #### Description Return all blog posts. #### Response ```json { "data": [ // Array of post objects ] } ``` --- ### 3.3 Get Post Count #### Endpoint ``` GET /api/getPostCount ``` #### Description Return total number of posts. #### Response ```json { "data": 42 } ``` --- ### 3.4 Get Posts by User #### Endpoint ``` GET /api/getPostByUser/{userId} ``` #### Description Return all posts by a specific user. #### Path Variable - `userId` (Long/String) #### Response ```json { "data": [ // Array of post objects by the user ] } ``` --- ### 3.5 Update Post #### Endpoint ``` POST /api/updatePost ``` #### Description Update an existing post. Only the author can update their own posts. #### Input (DTO) ```java public class UpdatePostDTO { private Long postId; private String title; private String content; // Add other fields as needed } ``` #### Checks - Only allow update if the JWT user is the author. --- ### 3.6 Delete Post #### Endpoint ``` GET /api/deletePost/{postId} ``` #### Description Delete a post by its ID. Only the author can delete their own posts. #### Path Variable - `postId` (Long) #### Checks - Only allow delete if the JWT user is the author. --- ## 4. Data Flow & Utilities - **DTOs:** Use DTO classes for all incoming and outgoing data. - **Response Format:** All controller responses should use a `genericSuccess(Object data)` method, always returning data under the `"data"` key. - **EntityHawk:** Use the `EntityHawk` utility class for entity management as required. - **Database:** Use H2 in-memory database only. Remove all MySQL or other DB configs. --- ## 5. Security - All `/api/*` endpoints require JWT authentication. - JWT must be passed as a bearer token in the `Authorization` header. --- ## 6. Example Response Structure ```json { "data": { // actual response object } } ``` --- ## 7. Dependencies - Spring Boot Web - Spring Data JPA - H2 Database - Spring Security (for JWT filter) - Lombok (optional for DTOs) --- ## 8. Example Database Entity ```java @Entity public class BlogPost { @Id @GeneratedValue private Long id; private String title; private String content; private Long authorId; // timestamps, etc. } ``` --- ## 9. Example JWT Auth Header ``` Authorization: Bearer <JWT_TOKEN> ``` --- ## 10. Notes - Ensure all DTOs are used for controller input/output. - Use only H2 database. - All data returned should use the `"data"` key. - Enforce update/delete restrictions based on post authorship. --- ## 11. Example API Flow 1. **Register User** → `/register` 2. **Login User** → `/login` (get JWT) 3. **Publish Post** → `/api/publish` (with JWT) 4. **Get All Posts** → `/api/getPost` (with JWT) 5. **Update Post** → `/api/updatePost` (with JWT, only by author) 6. **Delete Post** → `/api/deletePost/{postId}` (with JWT, only by author) --- **[No images required for this specification.]**