Skip to content

Latest commit

 

History

History
191 lines (138 loc) · 8.02 KB

README.md

File metadata and controls

191 lines (138 loc) · 8.02 KB

Project Banner

Bloggios Cloud Gateway

Java 17 Spring Boot Postgres Elasticsearch Elasticsearch

📋 Table of Contents

  1. 🤖 Introduction
  2. ⚙️ Tech Stack
  3. 🔋 Documentation
  4. 🤸 Quick Start
  5. 🕸️ Contributing
  6. 🔗 Links
  7. 🙏 Support
  8. ✨ Contributors

🤖 Introduction

Bloggios Cloud Gateway is an advanced API Gateway developed with Java 17 and Spring Boot, designed to serve as a centralized entry point for managing, routing, and monitoring API requests. It facilitates seamless integration between microservices by providing robust features such as load balancing, security enforcement, rate limiting, and request/response transformation. With its scalable and efficient architecture, Bloggios Cloud Gateway ensures reliable and high-performance communication within cloud environments, making it an essential component for modern, distributed applications.

Key Features

  • Load Balancing: Efficiently distributes incoming traffic across multiple servers to ensure high availability and reliability of services.
  • Rate Limiting: Controls the rate of incoming requests to prevent abuse and ensure fair usage of resources.
  • Dynamic Routing: Routes incoming API requests to the appropriate backend services based on predefined rules and conditions.
  • Request/Response Transformation: Modifies and transforms requests and responses to match the needs of different microservices and clients.
  • CORS Support: Handles Cross-Origin Resource Sharing (CORS) to enable secure cross-domain requests and data sharing.
  • Service Discovery Integration: Automatically discovers and routes to available services in a dynamic microservices environment.

Join our newly active Discord community for support, bug reporting, and feature requests. Here, we strive to address every issue, and developers and testers can collaborate and assist each other effectively.

Discord

⚙️ Tech Stack

  • Java 17
  • Spring Boot
  • Spring Cloud Gateway

🔋 API Documentation

To help you get started with our API and understand all its features and endpoints, we have created detailed documentation available on Postman. This documentation includes comprehensive information about each endpoint, including:

  • Endpoint URLs: Specific paths to access various functionalities.
  • HTTP Methods: The method type (GET, POST, PUT, DELETE, etc.) for each endpoint.
  • Parameters: Required and optional parameters, including headers, query parameters, and body content.
  • Request Examples: Sample requests to demonstrate proper usage.
  • Response Formats: Expected response structure, including status codes and data formats.
  • Error Handling: Common error responses and troubleshooting tips.

To access the documentation:

  1. **Visit our Postman Documentation Page **: Visit Documentation
  2. Explore the Collection: Navigate through the collection to find detailed descriptions and examples for each endpoint.
  3. Run Requests Directly in Postman: Use the "Run in Postman" button to directly import the collection into your Postman workspace for testing and exploration.

By leveraging the Postman documentation, you can quickly integrate our API into your application and take full advantage of its capabilities.

For any further assistance, feel free to contact our support team or refer to the additional resources section in the documentation.

🤸 Quick Start

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

  • Git
  • Java 17
  • Intellij Idea or any other IDE supports Spring Boot

Cloning the Repository

git clone <repository-url>

Opening the Project

Open the project in any of your favourite IDE We recommended Intellij Idea

Make sure you have Java 17 Installed in your system Please execute the below command to check installed version of Java in your system

java --version

Set Up Environment Variables

Navigate to src/main/resources/application.yml and add the required environment variables

If you are new at setting environment variables the please go through the below videos

EUREKA_URL: URL to service registry. (Leave it blank if you not want to connect)
SERVER_HOST: IP address of Host Machine. (Add localhost if you are using service registry on local)

Replace the placeholder values with your actual credentials

Running the Project

Navigate to src/main/java/com/bloggios/auth/provider/AuthProviderApplication.java Run the main method

🧑‍💻Contributing

Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.

If you wish to contribute, you can,

  • Star Repositories Bloggios
  • Suggest a Feature
  • Test the application, and help it improve.
  • Improve the app, fix bugs, etc.
  • Improve documentation.
  • Create content about Bloggios and share it with the world.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

🆕 New to Open Source? 💡 Follow this guide to jumpstart your Open Source journey 🚀.

🔗 Links

Repositories //add here

🙏Support

We all need support and motivation. Bloggios is not an exception. Please give this project repositories a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.

If you found the app helpful, consider supporting us with a coffee.

✨Contributors

Thanks goes to these wonderful people (emoji key):

Rohit Parihar
Rohit Parihar
💻