{"id":26742293,"url":"https://github.com/imkrunalkanojiya/jexpress","last_synced_at":"2025-07-31T15:34:10.476Z","repository":{"id":284543102,"uuid":"955279765","full_name":"imkrunalkanojiya/jexpress","owner":"imkrunalkanojiya","description":"ExpressJs inspired Java REST API Lightweight Framework","archived":false,"fork":false,"pushed_at":"2025-03-26T11:54:46.000Z","size":0,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-26T12:35:52.117Z","etag":null,"topics":["framework","java","java-framework","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/imkrunalkanojiya.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-03-26T11:53:18.000Z","updated_at":"2025-03-26T11:55:58.000Z","dependencies_parsed_at":"2025-03-26T12:47:32.003Z","dependency_job_id":null,"html_url":"https://github.com/imkrunalkanojiya/jexpress","commit_stats":null,"previous_names":["imkrunalkanojiya/jexpress"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/imkrunalkanojiya/jexpress","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imkrunalkanojiya%2Fjexpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imkrunalkanojiya%2Fjexpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imkrunalkanojiya%2Fjexpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imkrunalkanojiya%2Fjexpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/imkrunalkanojiya","download_url":"https://codeload.github.com/imkrunalkanojiya/jexpress/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/imkrunalkanojiya%2Fjexpress/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268065741,"owners_count":24190182,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["framework","java","java-framework","rest-api"],"created_at":"2025-03-28T06:17:21.332Z","updated_at":"2025-07-31T15:34:10.447Z","avatar_url":"https://github.com/imkrunalkanojiya.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JExpress\n\n## Overview\n\nThis Java REST API Framework provides a lightweight, flexible solution for building web applications and microservices with a focus on simplicity and ease of use.\n\n## Table of Contents\n- [Features](#features)\n- [Architecture](#architecture)\n- [Getting Started](#getting-started)\n- [Core Components](#core-components)\n- [Routing](#routing)\n- [Request Handling](#request-handling)\n- [Response Handling](#response-handling)\n- [Error Handling](#error-handling)\n- [Middleware](#middleware)\n- [Examples](#examples)\n- [Advanced Usage](#advanced-usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n### HTTP Method Support\n- Full support for standard HTTP methods:\n    - GET\n    - POST\n    - PUT\n    - DELETE\n    - PATCH\n    - HEAD\n    - OPTIONS\n\n### Routing Capabilities\n- Flexible path-based routing\n- Dynamic path parameter support\n- Route matching with regex patterns\n- Nested route configurations\n\n### Request Handling\n- Comprehensive request parsing\n- Header management\n- Query parameter extraction\n- Path parameter handling\n- Body content processing\n\n### Response Management\n- Flexible response generation\n- Multiple content type support\n- Status code management\n- Header manipulation\n\n### Error Handling\n- Centralized error management\n- Customizable error responses\n- Logging integration\n\n### Performance\n- Non-blocking I/O\n- Concurrent request processing\n- Lightweight design\n\n## Architecture\n\n### Core Components\n1. **Application**\n    - Main entry point for creating REST applications\n    - Server configuration\n    - Route registration\n\n2. **Router**\n    - Manages route definitions\n    - Handles route matching\n    - Supports dynamic routing\n\n3. **Request**\n    - Represents HTTP request\n    - Provides access to:\n        - Method\n        - Path\n        - Headers\n        - Query parameters\n        - Path parameters\n        - Request body\n\n4. **Response**\n    - Represents HTTP response\n    - Supports:\n        - Status code setting\n        - Header manipulation\n        - Body content generation\n        - Content type management\n\n5. **HttpMethod**\n    - Enum representing supported HTTP methods\n\n6. **Utilities**\n    - MimeTypes\n    - StatusCodes\n\n## Getting Started\n\n### Installation\n\n#### Maven Dependency\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.restapi\u003c/groupId\u003e\n    \u003cartifactId\u003ejava-rest-api-framework\u003c/artifactId\u003e\n    \u003cversion\u003e1.0-SNAPSHOT\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n### Basic Usage\n\n```java\npublic class HelloWorldApp {\n    public static void main(String[] args) {\n        // Create application\n        Application app = Application.create();\n        Router router = app.getRouter();\n\n        // Define routes\n        router.get(\"/hello\", (req, res) -\u003e {\n            res.json(\"{\\\"message\\\": \\\"Hello, World!\\\"}\");\n        });\n\n        // Start server\n        app.listen(8080).start();\n    }\n}\n```\n\n## Routing\n\n### Route Types\n- Static routes\n- Dynamic routes with path parameters\n- Query parameter support\n\n### Route Examples\n\n```java\n// Basic GET route\nrouter.get(\"/users\", (req, res) -\u003e {\n    // Fetch and return users\n});\n\n// Route with path parameter\nrouter.get(\"/users/{id}\", (req, res) -\u003e {\n    String userId = req.getPathParam(\"id\");\n    // Fetch specific user\n});\n\n// POST route\nrouter.post(\"/users\", (req, res) -\u003e {\n    // Create new user\n});\n```\n\n## Request Handling\n\n### Accessing Request Information\n\n```java\nrouter.get(\"/example\", (req, res) -\u003e {\n    // Get HTTP method\n    HttpMethod method = req.getMethod();\n\n    // Get path parameters\n    String userId = req.getPathParam(\"id\");\n\n    // Get query parameters\n    String searchQuery = req.getQueryParam(\"q\");\n\n    // Get headers\n    String contentType = req.getHeader(\"Content-Type\");\n\n    // Get request body\n    String body = req.getBody();\n});\n```\n\n## Response Handling\n\n### Response Methods\n\n```java\nrouter.get(\"/users\", (req, res) -\u003e {\n    // Set status code\n    res.setStatusCode(200);\n\n    // Set content type\n    res.setContentType(\"application/json\");\n\n    // Send JSON response\n    res.json(\"{\\\"users\\\": []}\");\n\n    // Send plain text\n    res.text(\"User list\");\n\n    // Add custom headers\n    res.addHeader(\"X-Custom-Header\", \"Value\");\n});\n```\n\n## Error Handling\n\n### Global Error Handling\n\n```java\nrouter.get(\"/users/{id}\", (req, res) -\u003e {\n    try {\n        // Business logic\n    } catch (Exception e) {\n        res.setStatusCode(500);\n        res.json(\"{\\\"error\\\": \\\"Internal Server Error\\\"}\");\n    }\n});\n```\n\n## Middleware\n\n### Middleware Support\n*Note: Comprehensive middleware support is planned for future releases*\n\n### Basic Middleware Concept\n```java\n// Middleware-like functionality\nrouter.get(\"/protected\", (req, res) -\u003e {\n    // Authentication check\n    if (!isAuthenticated(req)) {\n        res.setStatusCode(401);\n        res.json(\"{\\\"error\\\": \\\"Unauthorized\\\"}\");\n        return;\n    }\n\n    // Continue with request\n});\n```\n\n## Advanced Usage\n\n### Complex Routing\n\n```java\nrouter.get(\"/users\", this::listUsers);\nrouter.get(\"/users/{id}\", this::getUser);\nrouter.post(\"/users\", this::createUser);\nrouter.put(\"/users/{id}\", this::updateUser);\nrouter.delete(\"/users/{id}\", this::deleteUser);\n```\n\n## Configuration\n\n### Server Configuration\n\n```java\nApplication app = Application.create()\n    .listen(8080)     // Set port\n    .enableCORS()     // Enable CORS (future feature)\n    .start();\n```\n\n## Contributing\n\n### How to Contribute\n1. Fork the repository\n2. Create your feature branch\n3. Commit your changes\n4. Push to the branch\n5. Create a new Pull Request\n\n### Development Setup\n- Java 11+\n- Maven\n- JUnit 5 for testing\n\n## Performance Considerations\n- Use connection pooling\n- Implement caching mechanisms\n- Optimize database queries\n- Consider using reactive programming for I/O-bound tasks\n\n## Limitations\n- No built-in authentication\n- Basic middleware support\n- File upload requires extension\n- No WebSocket support (planned)\n\n## Future Roadmap\n- Enhanced middleware support\n- WebSocket integration\n- Advanced authentication\n- Comprehensive plugin system\n- Improved performance optimizations\n\n## License\nMIT License\n\n---\n\n**Disclaimer**: This framework is designed for educational and lightweight use cases. For production-grade applications, consider enterprise frameworks like Spring Boot.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimkrunalkanojiya%2Fjexpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fimkrunalkanojiya%2Fjexpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fimkrunalkanojiya%2Fjexpress/lists"}