https://github.com/a7bari/codecrafters-http-server-java
A lightweight HTTP server built in Java with support for dynamic routing, file handling, and gzip compression. Completed as part of the CodeCrafters challenge.
https://github.com/a7bari/codecrafters-http-server-java
build-your-own-http-server codecrafters http http-server java
Last synced: 6 months ago
JSON representation
A lightweight HTTP server built in Java with support for dynamic routing, file handling, and gzip compression. Completed as part of the CodeCrafters challenge.
- Host: GitHub
- URL: https://github.com/a7bari/codecrafters-http-server-java
- Owner: A7bari
- Created: 2024-12-03T18:54:18.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-12-03T19:06:51.000Z (10 months ago)
- Last Synced: 2025-02-08T00:41:32.288Z (8 months ago)
- Topics: build-your-own-http-server, codecrafters, http, http-server, java
- Language: Java
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Java HTTP Server
A lightweight HTTP server built in Java, capable of handling GET and POST requests, serving static files, and supporting dynamic routing. This project was completed as part of the CodeCrafters "Build Your Own HTTP Server" challenge.
## Features
- **Static and Dynamic Routing**:
- Supports both static routes and dynamic routes with path parameters (e.g., `/echo/{str}`).
- **Concurrency**:
- Handles multiple client connections using a thread pool.
- **File Handling**:
- Serve and write files dynamically to/from a specified directory.
- **Gzip Compression**:
- Supports gzip compression for response bodies.
- **Request and Response Management**:
- Easy-to-use abstractions for HTTP requests and responses.
## Getting Started
### Prerequisites
- Java Development Kit (JDK) 21 or higher
- Maven or any Java build tool of your choice
### Usage
1. Clone the repository:
```bash
git clone https://github.com/A7bari/codecrafters-http-server-java.git
cd codecrafters-http-server-java
```
2. Compile and run the server:
```bash
javac Main.java
java Main --directory=/path/to/serve/
```
3. Access the server at `http://localhost:4221`.
## Example Endpoints
- **GET /**: Returns a `200 OK` response.
- **GET /echo/{str}**: Echoes the given string.
- **GET /user-agent**: Returns the client's `User-Agent` header.
- **GET /files/{filename}**: Serves a file from the specified directory.
- **POST /files/{filename}**: Writes a file to the specified directory with the content in the request body.
## Project Structure
- **HttpServer**: Main server class for managing client connections.
- **Router**: Handles routing for different HTTP methods and paths.
- **HttpRequest** and **HttpResponse**: Abstractions for HTTP request/response.
- **FileUtil**: Utility for file I/O operations.
- **ReqHandler**: Parses incoming HTTP requests.
## Future Enhancements
- Add support for HTTPS.
- Implement additional HTTP methods (PUT, DELETE).
- Integrate structured logging.
- Introduce automated testing (unit and integration tests).
## License
This project is licensed under the MIT License.