https://github.com/mattiadeidda91/test-backend

Microservices Kafka Projects
https://github.com/mattiadeidda91/test-backend

automapper c-sharp entity-framework-core kafka microservices net6 refit rest-api serilog xunit-tests

Last synced: 7 months ago
JSON representation

Microservices Kafka Projects

• Host: GitHub
• URL: https://github.com/mattiadeidda91/test-backend
• Owner: mattiadeidda91
• License: mit
• Created: 2024-08-06T23:00:09.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-13T08:03:24.000Z (about 1 year ago)
• Last Synced: 2025-01-22T18:24:52.662Z (9 months ago)
• Topics: automapper, c-sharp, entity-framework-core, kafka, microservices, net6, refit, rest-api, serilog, xunit-tests
• Language: C#
• Homepage:
• Size: 211 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
## Name

test-backend

## Scope

A minimal order management system with:

- Microservices

- REST API

- EntityFramework for SQL Server database

- Serilog for logging

- Kafka

- Refit

- Polly

- XUnit Test

## Description

- VisualStudio2022

- Framework net6.0

- Each microservice manages its own database

- Communication between microservices occurs via Kafka messageBus

- The WebApi project exposes Api Rest to perform CRUD operations on entities.

- The WebApi project sends sends the received request to the specific microservice, each with a specific topic.


 The microservice performs the operation and sends a response message to the Producer (WebApi) which listens on the Controller to allow the caller to be answered

## Dependencies Projects

Test.Backend.Abstractions


Test.Backend.Database -> Test.Backend.Abstractions


Test.Backend.HttpClient -> Test.Backend.Abstractions


Test.Backend.Kafka -> Test.Backend.Abstractions


Test.Backend.Dependencies -> Test.Backend.Database


Test.Backend.Dependencies -> Test.Backend.HttpClient


Test.Backend.Dependencies -> Test.Backend.Kafka


Test.Backend.WebApi -> Test.Backend.Dependencies


Test.Backend.Services.AddressService -> Test.Backend.Dependencies


Test.Backend.Services.ProductService -> Test.Backend.Dependencies


Test.Backend.Services.UserService -> Test.Backend.Dependencies


Test.Backend.Services.OrderService -> Test.Backend.Dependencies


## Usage

1. The docker-compose file is present in the root of the project to allow Kafka to work locally.


   The kafka_ui port is configured on 8084, if there are problems it is necessary to change it with an unused port.

2. If it is necessary to install Ubuntu and Docker I leave the following installation and configuration links:


	a. Ubuntu: https://canonical-ubuntu-wsl.readthedocs-hosted.com/en/latest/guides/install-ubuntu-wsl2/


	b. Docker: https://docs.docker.com/engine/install/ubuntu/


	c. Docker PostInstall: https://docs.docker.com/engine/install/linux-postinstall/


3. Once Docker is configured you need to start the services with the command:


	 **sudo service docker start**

4. Next it needs to run the docker-docker-compose.yml file with the command:


	**docker-compose -f '{pathFile}/docker-compose.yml' up --build -d**


   Where {pathFile} should be replaced with the physical path of the file.


   Example path file: **docker-compose -f '/mnt/c/Users/mdeidda/Documents/Visual Studio 2022/Projects/test-backend/docker-compose.yml' up --build -d**

5. Open the solution **test-backend.sln**

6. In the **appsettings.json** and **appsettings.Development.json** of each microservice add your own connectionString to connect to SqlServer.


   The projects in which you will need to change the connectionString are as follows:


		a. **Test.Backend.Services.AddressService**


		b. **Test.Backend.Services.OrderService**


		c. **Test.Backend.Services.ProductService**


		d. **Test.Backend.Services.UserService**


	If you run the project in Debug, you can only modify the file **appsettings.Development.json**.


	It is recommended to only change the Server name of the SqlServer instance without changing the database name.

7. Startup projects should already be configured, verify in Solution Properties that WebApi projects and all microservices are set as Startup projects.


   If they need to be configured, select the **Multiple startup projects** item and set the **Action** to **Start** for the following projects:


		a. **Test.Backend.WebApi**


		b. **Test.Backend.Services.AddressService**


		c. **Test.Backend.Services.OrderService**


		d. **Test.Backend.Services.ProductService**


		e. **Test.Backend.Services.UserService**


	Then apply the changes and click OK.

8. Start projects with VisualStudio's Start button.

9. The migration scripts should already be set up in the project and automatically run at startup.


   If databases are not created when starting and opening all projects, you need to launch the **Add-Migration InitialCreate** and then **Update-Database** commands on the Package Manager Console.


   These commands will need to be run for all microservices projects:


		a. **Test.Backend.Services.AddressService**


		b. **Test.Backend.Services.OrderService**


		c. **Test.Backend.Services.ProductService**


		d. **Test.Backend.Services.UserService**


10. If there are Kafka errors on the consoles when starting the projects, perform the following steps:


		a. Stop VisualStudio projects.


		b. Execute this command to restart docker service:


			**sudo service docker restart**


		c. Execute this command to stop container:


			**docker-compose -f '{pathFile}/docker-compose.yml' down -v**


		d. Execute this command to start container :


			**docker-compose -f '{pathFile}/docker-compose.yml' up --build -d**


		e. Start VisualStudio projects again and verify that the error has not recurred.


11. Once the projects are all open, verify that the project URLs and ports match within the **appsettings.json** and **appsettings.Development.json** files of the **Test.Backend.Services.OrderService** project.


	If they differ, you are asked to stop the projects, update the **BaseAddresses** fields for all **Clients** in **HttpRefitPollyOptions** of all the endpoints and restart the project.

12. The controllers are exposed from the Swagger UI page of the WebApi project.


	To generate an order it is necessary to create all the other entities first.


	Sequence example:


		a. Create Category


		b. Create Product with specific Category


		c. Create User


		d. Create Address


		e. Create Order with Products, User and Address


## License

2024 - Copyright (c) All rights reserved.