This project is a sample microservice architecture using Spring Cloud. It demonstrates how to build, deploy, and manage a scalable and maintainable microservice system. The example includes several components such as a discovery server, config server, API gateway, auth server, multiple sample services, and an observability stack.
- Discovery Server
- Config Server
- API Gateway
- Auth Server
- Observability
- Sample Service 1
- Sample Service 1 Client
- Sample Service 2
- Sample Service 2 Client
The Discovery Server is responsible for service registration and discovery, allowing microservices to locate and communicate with each other in a distributed system. Learn more
The Config Server serves as a centralized configuration service for all microservices in your system, providing versioned configuration data for applications. Learn more
The API Gateway acts as a single entry point for all microservices within the system, providing load balancing, routing, and other features to improve the system's scalability and maintainability. Learn more
The Auth Server is responsible for handling authentication and authorization of users, providing secure access to protected resources across microservices. Learn more
The observability module contains monitoring and logging systems that provide insights into the microservices behavior and performance in real-time. It includes Elasticsearch, Logstash, and Kibana (ELK Stack) for log aggregation, search, and visualization. Additionally, it uses Grafana, Prometheus, and Zipkin for real-time monitoring and tracing of the microservices.
-
The logging system is based on ELK Stack which collects, processes, and visualizes microservices' logs. Learn more
-
The monitoring system uses Grafana and Prometheus for real-time monitoring, and Zipkin for distributed tracing. Learn more
Sample Service 1 is a microservice within the project that demonstrates the capabilities of a Spring Boot-based microservice. Learn more
Sample Service 1 Client is a library within the project that provides an easy-to-use client for the Sample Service 1 microservice. It includes a Feign client, OAuth2 support, and Spring Boot auto-configuration. Learn more
Sample Service 2 is a microservice within the project that demonstrates the capabilities of a Spring Boot-based microservice. Learn more
Sample Service 2 Client is a library within the project that provides an easy-to-use client for the Sample Service 2 microservice. It includes a Feign client, OAuth2 support, and Spring Boot auto-configuration. Learn more
Please refer to the README files of each individual component for instructions on how to build, configure, and run them.
-
Endpoint:
GET http://127.0.0.1:4000/service-1/echo
Curl:
curl --location 'http://127.0.0.1:4000/service-1/echo' \ --header 'Authorization: Bearer {authorization token}'
Response:
{ "echo": "[sample-service-1] : echo" } -
Endpoint:
GET http://127.0.0.1:4000/service-1/echo/service-1-to-service-2
Curl:
curl --location 'http://127.0.0.1:4000/service-1/echo/service-1-to-service-2' \ --header 'Authorization: Bearer {authorization token}'
Response:
{ "echo": "[sample-service-2] echo" }
-
Endpoint:
GET http://127.0.0.1:4000/service-2/echo
Curl:
curl --location 'http://127.0.0.1:4000/service-2/echo' \ --header 'Authorization: Bearer {authorization token}'
Respose:
{ "echo": "[sample-service-2] : echo" } -
Endpoint:
GET http://127.0.0.1:4000/service-2/echo/service-2-to-service-1
Curl:
curl --location 'http://127.0.0.1:4000/service-2/echo/service-1-to-service-2' \ --header 'Authorization: Bearer {authorization token}'
Respose:
{ "echo": "[sample-service-1] : echo" }
Please feel free to submit issues, fork the repository, and send pull requests to contribute to the project.
This project is licensed under the terms of the MIT License.