Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/farnam-hs/blogging-platform-api
A RESTful API built with Java, using Jersey and MySQL. It supports CRUD operations for blog posts, with a focus on clean architecture and separation of concerns.
https://github.com/farnam-hs/blogging-platform-api
database jakarta-ee java jax-rs jdbc jersey junit maven mockito restful-api
Last synced: about 2 months ago
JSON representation
A RESTful API built with Java, using Jersey and MySQL. It supports CRUD operations for blog posts, with a focus on clean architecture and separation of concerns.
- Host: GitHub
- URL: https://github.com/farnam-hs/blogging-platform-api
- Owner: Farnam-Hs
- Created: 2024-09-16T10:27:48.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-10T07:39:31.000Z (3 months ago)
- Last Synced: 2024-12-01T19:08:01.488Z (about 2 months ago)
- Topics: database, jakarta-ee, java, jax-rs, jdbc, jersey, junit, maven, mockito, restful-api
- Language: Java
- Homepage:
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
---
# Blogging Platform API
---
## 🎯 Overview
This project is a RESTful API for managing a blogging platform, where users can create, read, update, and delete (CRUD) blog posts, as well as search for posts. The API ensures a clean separation of concerns through layered architecture and follows industry best practices for building scalable and maintainable web service.
---
## ✨ Features
- **CRUD Operations for Blog Posts:** Create, read, update, and delete blog posts.
- **Search Functionality:** Search posts by title, content, or category using wildcard search.
- **Status Code Handling:** Proper use of HTTP status codes for all operations (e.g., 201 Created, 204 No Content, 404 Not Found, 500 Internal Server Error).
- **Exception Handling:** Custom exceptions and mappers to return meaningful error messages and responses.
- **Immutability:** Entities, such as Post, are immutable after creation, providing stability and clear data management
- **Testing:** Unit and integration tests ensure reliability, covering all critical aspects of the application.
---
## 🛠️ Technologies Used
- **Java (Jakarta EE 10):** Core language used to build the API.
- **Jersey (JAX-RS):** Used for creating RESTful web service and managing API routes.
- **Tomcat:** Servlet container used to deploy and run the application.
- **MySQL:** The primary relational database for persisting blog post data.
- **H2 Database:** In-memory database used for testing.
- **JUnit & Mockito & JerseyTest:** For unit and integration testing of the service, DAO, and controller.
- **JDBC:** Manages direct database interactions without using JPA.
- **Flyway:** Manages database versioning and migrations, ensuring smooth updates and schema changes.
- **Jackson:** Library for JSON serialization and deserialization.
- **Maven:** Build automation and dependency management tool.
---
## 🏛️ Design and Architecture
This project follows a **layered architecture** approach with a clear separation of concerns between the controller, service, and data access layers:
**1. Controller Layer:**
- Handles HTTP requests and responses, and manages interaction with the service layer.
- Example: ``PostResource.java`` for all post-related endpoints.
**2. Service Layer:**
- Implements the core business logic of the application, such as creating or updating posts, and orchestrating between the controller and DAO layers.
- Example: ``PostServiceImpl.java`` contains the logic for managing posts.
**3. DAO Layer:**
- Directly interacts with the database using JDBC, executing SQL queries for creating, reading, updating, and deleting records.
- Example: ``PostDaoImpl.java`` manages the persistence of post entities.
### Project Structure
```
src/
│
├── main/
│ ├── java/com/farnamhs/blogging/
│ │ ├── config/ # Application setup and database initializer
│ │ ├── controller/ # API controllers (e.g., PostResource.java)
│ │ ├── dao/ # Data Access Objects (DAO) for interacting with the database
│ │ ├── dto/ # Data Transfer Objects (DTOs) for request and response models
│ │ ├── entity/ # Entity classes (e.g., Post.java)
│ │ ├── exception/ # Custom exceptions and mappers
│ │ ├── mapper/ # Mappers for converting entities to DTOs and vice versa
│ │ ├── service/ # Business logic and service implementations
│ │ └── util/ # Utility classes
│ └── resources/
│ └── db/migration/ # Flyway migration scripts
└── test/
├── java/ # Unit and integration tests
└── resources/ # Test configuration and data
```
---
## ️ 🔭 API Endpoints
### POST ``/api/posts``
- **Description:** Create a new blog post.
- **Request:**
- ``POST`` body must include title, content, category, and tags.
```json
{
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"]
}
```
- **Response:**
- ``201 Created`` with the newly created post.
```json
{
"id": 1,
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"],
"createdAt": "2024-10-09T12:00:00Z",
"updatedAt": "2024-10-09T12:00:00Z"
}
```
- ```400 Bad Request``` with error messages in case of validation errors.
### GET ``/api/posts/{id}``
- **Description:** Retrieve a post by its ID.
- **Response:**
- ``200 OK`` with the post details.
- Example: ``GET /api/posts/1``
```json
{
"id": 1,
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"],
"createdAt": "2024-10-09T12:00:00Z",
"updatedAt": "2024-10-09T12:00:00Z"
}
```
- ```404 Not Found``` if the blog post was not found.
### GET ``/api/posts?term={term}``
- **Description:** Search posts by title, content, or category.
- **Response:**
- ``200 OK`` with a list of matching posts or all posts if no term is provided.
- Example: ``GET /api/posts``
```json
[
{
"id": 1,
"title": "My First Blog Post",
"content": "This is the content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"],
"createdAt": "2024-10-09T12:00:00Z",
"updatedAt": "2024-10-09T12:00:00Z"
},
{
"id": 2,
"title": "My Second Blog Post",
"content": "This is the content of my second blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"],
"createdAt": "2024-10-09T12:30:00Z",
"updatedAt": "2024-10-09T12:30:00Z"
}
]
```
### PUT ``/api/posts/{id}``
- **Description:** Update an existing post.
- **Request:**
- ``PUT`` body must include updated title, content, category, and tags.
```json
{
"title": "My Updated Blog Post",
"content": "This is the updated content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"]
}
```
- **Response:**
- ``200 OK`` with the updated blog post.
```json
{
"id": 1,
"title": "My Updated Blog Post",
"content": "This is the updated content of my first blog post.",
"category": "Technology",
"tags": ["PROGRAMMING", "TECH"],
"createdAt": "2024-10-09T12:00:00Z",
"updatedAt": "2024-10-09T12:30:00Z"
}
```
- ``400 Bad Request`` with error messages in case of validation errors.
- ``404 Not Found`` if the blog post was not found.
### DELETE ``/api/posts/{id}``
- **Description:** Delete a post by its ID.
- **Response:**
- ``204 No Content`` if the blog post was successfully deleted.
- ``404 Not Found`` if the blog post was not found.
---
Sample solution for the [Blogging Platform API](https://roadmap.sh/projects/blogging-platform-api) challenge from [roadmap.sh](https://roadmap.sh/).