Satya2008 / blog_api

"Blog REST API for user-friendly blog management. Create, update, delete, and retrieve users, posts, categories, and comments. Simplify content interaction for administrators and users." https://drive.google.com/file/d/1HOiv7zayn7uKxeLf7uAbYb-ai1_MbgmA/view?usp=sharing

Blog Project REST API

This project is a Blog REST API that allows users and administrators to manage and interact with blog-related entities, such as users, posts, categories, and comments. It provides endpoints for various operations including creating, updating, deleting, and retrieving these entities.

Features

User Operations

Sign Up:

• New users can create their accounts by providing their email and password. Their passwords are securely stored using encryption.

Update Profile:

• Users can modify their profile information, including their email address and password.

Delete Account:

• Users have the option to delete their accounts, which will remove their data from the platform.

View Posts:

• Users can read and view blog posts published on the platform.

Browse Categories:

• Users can explore different categories under which blog posts are organized.

Search Posts:

• Users can search for posts using keywords to find specific topics.

Leave Comments:

• Users can interact with blog posts by leaving comments.

Admin Operations

Admin Sign In:

• Admins can access the administrative panel by logging in with their credentials.

Create Admin Account:

• Existing admins can create new admin accounts for other authorized users.

Update Admin Profile:

• Admins can update their own profile information, just like regular users.

Delete Admin Account:

• Admins have the ability to delete their own accounts.

Create Blog Posts:

• Admins can write and publish new blog posts to share content.

Edit Blog Posts:

• Admins can edit existing blog posts to update or correct information.

Delete Blog Posts:

• Admins can remove outdated or irrelevant blog posts.

Manage Categories:

• Admins can create, update, and delete categories to organize content.

Moderate Comments:

• Admins can review and moderate user comments to ensure compliance with guidelines.

Installation and Setup

1. Clone this repository to your local machine. Install the required dependencies using npm install or yarn install.

2. Configure the database settings in the application.properties file.

3. Run the application using mvn spring-boot:run.

API Documentation

The API documentation can be accessed by running the application and visiting https://blogapi-production-b26d.up.railway.app/swagger-ui/index.html

http://localhost:8080/swagger-ui.html. This provides a user-friendly interface to interact with the API endpoints and understand their functionality.

Technologies Used

• Spring Boot
• Spring Security
• JWT Authentication
• Spring Data JPA
• Swagger (API Documentation)
• MySQL (Database)
• Java Cryptography for password encryption

Contribution

Contributions are welcome! If you find any issues or would like to add new features, please feel free to submit a pull request.

Contact

For any inquiries or feedback, please contact - [e-mail]

Screenshots