Consul integration with serviceName prefix and ConsulClient library #313
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <Nullable>enable</Nullable> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4"/> | ||
| <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\..\src\MMLib.ServiceDiscovery.Consul\MMLib.ServiceDiscovery.Consul.csproj" /> | ||
| </ItemGroup> | ||
|
|
||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| using MMLib.ServiceDiscovery.Consul.DependencyInjection; | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
|
|
||
| // Add services to the container. | ||
| // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle | ||
| builder.Services.AddEndpointsApiExplorer(); | ||
| builder.Services.AddSwaggerGen(); | ||
|
|
||
| builder.AddConsulAutoServiceDiscovery("http://localhost:8500"); //This line added | ||
|
|
||
| var app = builder.Build(); | ||
|
|
||
| // Configure the HTTP request pipeline. | ||
| if (app.Environment.IsDevelopment()) | ||
| { | ||
| app.UseSwagger(); | ||
| app.UseSwaggerUI(); | ||
| } | ||
|
|
||
| app.UseHttpsRedirection(); | ||
|
There was a problem hiding this comment. Potential mismatch between HTTPS redirection and application URL You have |
||
|
|
||
| app.UseSwaggerForOcelotUI(); //This line added | ||
|
|
||
| var summaries = new[] | ||
| { | ||
| "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" | ||
| }; | ||
|
|
||
| app.MapGet("/weatherforecast", () => | ||
| { | ||
| var forecast = Enumerable.Range(1, 5).Select(index => | ||
| new WeatherForecast | ||
| ( | ||
| DateOnly.FromDateTime(DateTime.Now.AddDays(index)), | ||
| Random.Shared.Next(-20, 55), | ||
| summaries[Random.Shared.Next(summaries.Length)] | ||
| )) | ||
| .ToArray(); | ||
| return forecast; | ||
| }) | ||
| .WithName("GetWeatherForecast") | ||
| .WithOpenApi(); | ||
|
|
||
| app.Run("http://localhost:7002"); | ||
|
|
||
| record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary) | ||
| { | ||
| public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,18 @@ | ||||||||||||||||||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||||||||||||||||||
|
|
||||||||||||||||||
| <PropertyGroup> | ||||||||||||||||||
| <TargetFramework>net8.0</TargetFramework> | ||||||||||||||||||
| <Nullable>enable</Nullable> | ||||||||||||||||||
| <ImplicitUsings>enable</ImplicitUsings> | ||||||||||||||||||
| </PropertyGroup> | ||||||||||||||||||
|
|
||||||||||||||||||
| <ItemGroup> | ||||||||||||||||||
| <PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4"/> | ||||||||||||||||||
| <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0"/> | ||||||||||||||||||
| </ItemGroup> | ||||||||||||||||||
|
Comment on lines
+9
to
+12
There was a problem hiding this comment. 🛠️ Refactor suggestion Update Swashbuckle.AspNetCore to the latest version. While the Microsoft.AspNetCore.OpenApi package is up-to-date, the Swashbuckle.AspNetCore package (6.4.0) is not the latest version. Given the importance of Swagger in this project, it's recommended to use the most recent stable version. Update the Swashbuckle.AspNetCore package to the latest stable version: <ItemGroup>
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="8.0.4"/>
- <PackageReference Include="Swashbuckle.AspNetCore" Version="6.4.0"/>
+ <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0"/>
</ItemGroup>This update ensures you have the latest features and bug fixes for Swagger integration. 📝 Committable suggestion
Suggested change
|
||||||||||||||||||
|
|
||||||||||||||||||
| <ItemGroup> | ||||||||||||||||||
| <ProjectReference Include="..\..\..\src\MMLib.SwaggerForOcelot\MMLib.SwaggerForOcelot.csproj" /> | ||||||||||||||||||
| </ItemGroup> | ||||||||||||||||||
|
|
||||||||||||||||||
| </Project> | ||||||||||||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| using Ocelot.DependencyInjection; | ||
| using Ocelot.Provider.Consul; | ||
| using Ocelot.Middleware; | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
| builder.Services.AddEndpointsApiExplorer(); | ||
|
|
||
| builder.Configuration | ||
| .SetBasePath(builder.Environment.ContentRootPath) | ||
| .AddJsonFile("ocelot.json", optional: false, reloadOnChange: true) | ||
| .AddEnvironmentVariables(); | ||
|
|
||
| builder.Services | ||
| .AddOcelot(builder.Configuration) | ||
| .AddConsul(); | ||
|
|
||
| builder.Services.AddSwaggerForOcelot(builder.Configuration); | ||
|
|
||
| var app = builder.Build(); | ||
|
|
||
| app.UseSwaggerForOcelotUI(); | ||
| await app.UseOcelot(); | ||
|
|
||
| app.MapGet("/", () => "Hello World!").WithOpenApi(); | ||
| app.Run("http://0.0.0.0:7001"); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "Logging": { | ||
| "LogLevel": { | ||
| "Default": "Information", | ||
| "Microsoft.AspNetCore": "Warning" | ||
| } | ||
| }, | ||
| "AllowedHosts": "*" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| { | ||
| "Routes": [], | ||
| "SwaggerEndPoints": [], | ||
| "GlobalConfiguration": { | ||
| "ServiceDiscoveryProvider": { | ||
| "Scheme": "http", | ||
| "Host": "localhost", | ||
| "Port": 8500, | ||
| "Type": "PollConsul", | ||
| "PollingInterval": 100 | ||
| } | ||
| } | ||
| } | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| using Microsoft.AspNetCore.Builder; | ||
| using Microsoft.Extensions.DependencyInjection; | ||
| using Swashbuckle.AspNetCore.SwaggerUI; | ||
|
|
||
| namespace MMLib.ServiceDiscovery.Consul.DependencyInjection; | ||
|
|
||
| /// <summary> | ||
| /// | ||
| /// </summary> | ||
| public static class ConfigureExtensions | ||
| { | ||
| /// <summary> | ||
| /// | ||
| /// </summary> | ||
| /// <param name="builder"></param> | ||
| /// <returns></returns> | ||
| public static IApplicationBuilder UseSwaggerForOcelotUI(this WebApplication builder) | ||
| { | ||
| builder.ConfigureConsulConnection(); | ||
| builder.MapHealthChecks("/api/health"); | ||
|
|
||
| return builder; | ||
| } | ||
|
Comment on lines
+17
to
+23
There was a problem hiding this comment. Review method name and implementation for Swagger UI. The method name
Ensure that the method aligns with its intended purpose and that its name accurately describes its functionality. |
||
|
|
||
| /// <summary> | ||
| /// | ||
| /// </summary> | ||
| /// <param name="builder"></param> | ||
| /// <returns></returns> | ||
| public static IApplicationBuilder ConfigureConsulConnection(this IApplicationBuilder builder) | ||
| { | ||
| var consul = builder.ApplicationServices.GetService<IConsulConnectionService>(); | ||
| consul?.Start(); | ||
|
|
||
| return builder; | ||
| } | ||
|
Comment on lines
+30
to
+36
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance error handling and service resolution in ConfigureConsulConnection. Consider the following improvements to make the method more robust:
These changes will improve the method's reliability and provide better feedback if issues occur during Consul connection setup. |
||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Consider reading the Consul URL from configuration
The Consul service URL is hardcoded as
"http://localhost:8500". To enhance flexibility and maintainability, consider fetching this value from the application's configuration files (e.g.,appsettings.json). This approach allows you to modify the Consul address without changing the code base when moving between environments.Apply this diff to update the code:
Remember to add the Consul address to your configuration file:
{ "Consul": { "Address": "http://localhost:8500" } }