Refactor Swagger Endpoint Validation and Implement Custom Options Handling #315
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(); | ||||||||||||||||
|
|
||||||||||||||||
| app.UseSwaggerForOcelotUI(); //This line added | ||||||||||||||||
|
There was a problem hiding this comment. Limit Swagger UI exposure to development environment The Proposed change: 15 if (app.Environment.IsDevelopment())
16 {
17 app.UseSwagger();
18 app.UseSwaggerUI();
+ app.UseSwaggerForOcelotUI(); // Moved inside the development check
19 }
- app.UseSwaggerForOcelotUI(); //This line removed📝 Committable suggestion
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| 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"); | ||||||||||||||||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Avoid hardcoding the application URL in Hardcoding the application URL directly in Proposed change: - app.Run("http://localhost:7002");
+ app.Run();Then, in your {
"profiles": {
"AutoDiscoveryApi": {
"commandName": "Project",
"launchBrowser": true,
"applicationUrl": "http://localhost:7002",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
} |
||||||||||||||||
|
|
||||||||||||||||
| record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary) | ||||||||||||||||
| { | ||||||||||||||||
| public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); | ||||||||||||||||
|
There was a problem hiding this comment. 🛠️ Refactor suggestion Use standard formula for Celsius to Fahrenheit conversion The current calculation for Proposed change: - public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+ public int TemperatureF => 32 + (int)(TemperatureC * 9 / 5);📝 Committable suggestion
Suggested change
|
||||||||||||||||
| } | ||||||||||||||||
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> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\..\src\MMLib.SwaggerForOcelot\MMLib.SwaggerForOcelot.csproj" /> | ||
| </ItemGroup> | ||
rabdulatif marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| </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. Revise method name and implementation to match functionality The
Here's a suggested implementation: public static WebApplication ConfigureConsulAndHealthChecks(this WebApplication app)
{
app.ConfigureConsulConnection();
app.MapHealthChecks("/api/health");
return app;
}If Swagger UI setup is needed, consider adding it to this method or creating a separate method for it. |
||
|
|
||
| /// <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; | ||
| } | ||
| } | ||
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
Avoid hardcoding the Consul service discovery URL
Hardcoding the Consul service URL reduces flexibility and complicates deployment to different environments. It's recommended to retrieve the URL from configuration files or environment variables. This approach enhances maintainability and allows easy configuration changes without modifying code.
Proposed change:
Ensure that the
ConsulConfig:ConsulUrlsetting is defined in your configuration files (e.g.,appsettings.json):{ "ConsulConfig": { "ConsulUrl": "http://localhost:8500" } }