diff --git a/README.md b/README.md index 5585d31..91d8e47 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,31 @@ # 🌐 API Gateway +## 🚦 Build Status + +**main** + [![Build and Test API Gateway](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml/badge.svg)](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml) +**dev** + +[![Build and Test API Gateway](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml/badge.svg?branch=dev)](https://github.com/TechTorque-2025/API_Gateway/actions/workflows/buildtest.yaml) + This service is the single entry point for all client requests in the TechTorque 2025 system. It is responsible for routing, authentication, rate limiting, and enriching requests. ### 🎯 Key Responsibilities -- **Request Routing:** Maps incoming URL paths (e.g., `/api/v1/vehicles`) to the correct internal microservice (e.g., `vehicle-service`). -- **Authentication:** Validates JWTs for all protected endpoints. -- **Header Enrichment:** Injects `X-User-Subject` and `X-User-Roles` headers into requests after successful authentication. -- **CORS:** Manages all Cross-Origin Resource Sharing policies for the frontend application. +- **Request Routing:** Maps incoming URL paths (e.g., `/api/v1/vehicles`) to the correct internal microservice (e.g., `vehicle-service`). +- **Authentication:** Validates JWTs for all protected endpoints. +- **Header Enrichment:** Injects `X-User-Subject` and `X-User-Roles` headers into requests after successful authentication. +- **CORS:** Manages all Cross-Origin Resource Sharing policies for the frontend application. ### ⚙️ Tech Stack -- **Language:** Go -- **Router:** `chi/v5` -- **JWT Library:** `golang-jwt/jwt/v5` +![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge&logo=go&logoColor=white) ![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white) + +- **Language:** Go +- **Router:** `chi/v5` +- **JWT Library:** `golang-jwt/jwt/v5` ### 🚀 Running Locally @@ -23,4 +33,5 @@ This service is designed to be run as part of the main `docker-compose` setup fr ```bash # From the root of the TechTorque-2025 project -docker-compose up --build api-gateway \ No newline at end of file +docker-compose up --build api-gateway +```