[DRAFT] feat: Text*Formatter impl & ASP.NET Core API example #224
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| **/.classpath | ||
| **/.dockerignore | ||
| **/.env | ||
| **/.git | ||
| **/.gitignore | ||
| **/.project | ||
| **/.settings | ||
| **/.toolstarget | ||
| **/.vs | ||
| **/.vscode | ||
| **/*.*proj.user | ||
| **/*.dbmdl | ||
| **/*.jfm | ||
| **/azds.yaml | ||
| **/bin | ||
| **/charts | ||
| **/docker-compose* | ||
| **/Dockerfile* | ||
| **/node_modules | ||
| **/npm-debug.log | ||
| **/obj | ||
| **/secrets.dev.yaml | ||
| **/values.dev.yaml | ||
| LICENSE | ||
| README.md | ||
| !**/.gitignore | ||
| !.git/HEAD | ||
| !.git/config | ||
| !.git/packed-refs | ||
| !.git/refs/heads/** |
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,43 @@ | ||||||
| using Microsoft.AspNetCore.Http.Extensions; | ||||||
| using Microsoft.AspNetCore.Mvc; | ||||||
|
|
||||||
| namespace OSLC4NetExamples.Server.NetCoreApi.Controllers; | ||||||
| [ApiController] | ||||||
| [Route("[controller]")] | ||||||
| public class WeatherForecastController : ControllerBase | ||||||
| { | ||||||
| private static readonly string[] Summaries = new[] | ||||||
| { | ||||||
| "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching" | ||||||
| }; | ||||||
|
|
||||||
| private readonly ILogger<WeatherForecastController> _logger; | ||||||
|
|
||||||
| public WeatherForecastController(ILogger<WeatherForecastController> logger) | ||||||
| { | ||||||
| _logger = logger; | ||||||
| } | ||||||
|
|
||||||
| [HttpGet] | ||||||
| [Route("oslc")] | ||||||
| public OSLC4Net.Core.Model.ServiceProvider Oslc() | ||||||
| { | ||||||
| var sp = new OSLC4Net.Core.Model.ServiceProvider(); | ||||||
| sp.SetAbout(new Uri(Request.GetEncodedUrl())); | ||||||
| sp.SetDescription("test me"); | ||||||
| return sp; | ||||||
| } | ||||||
|
|
||||||
| [HttpGet(Name = "GetWeatherForecast")] | ||||||
| [Route("forecast")] | ||||||
| public IEnumerable<WeatherForecast> Get() | ||||||
| { | ||||||
| return Enumerable.Range(1, 5).Select(index => new WeatherForecast | ||||||
| { | ||||||
| Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)), | ||||||
|
There was a problem hiding this comment. Improve DateTime handling for web API scenarios. Using Consider this improvement: - Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+ Date = DateOnly.FromDateTime(DateTime.UtcNow.AddDays(index)),For better timezone handling, consider:
📝 Committable suggestion
Suggested change
|
||||||
| TemperatureC = Random.Shared.Next(-20, 55), | ||||||
| Summary = Summaries[Random.Shared.Next(Summaries.Length)] | ||||||
| }) | ||||||
| .ToArray(); | ||||||
| } | ||||||
|
Comment on lines
+31
to
+42
There was a problem hiding this comment. 🛠️ Refactor suggestion Improve API robustness and configurability. The current implementation needs several improvements:
[HttpGet(Name = "GetWeatherForecast")]
[Route("forecast")]
+[ResponseCache(Duration = 60)] // Cache for 1 minute
+[ProducesResponseType(typeof(IEnumerable<WeatherForecast>), StatusCodes.Status200OK)]
+[ProducesResponseType(StatusCodes.Status400BadRequest)]
-public IEnumerable<WeatherForecast> Get()
+public ActionResult<IEnumerable<WeatherForecast>> Get(
+ [FromQuery] DateOnly? startDate,
+ [FromQuery] int days = 5)
{
- return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+ if (days <= 0 || days > _configuration.GetValue<int>("MaxForecastDays", 7))
+ {
+ return BadRequest("Invalid number of days requested");
+ }
+
+ var start = startDate ?? DateOnly.FromDateTime(DateTime.Now);
+ return Ok(Enumerable.Range(1, days).Select(index => new WeatherForecast
{
- Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+ Date = start.AddDays(index),
TemperatureC = Random.Shared.Next(-20, 55),
Summary = Summaries[Random.Shared.Next(Summaries.Length)]
})
- .ToArray();
+ .ToArray());
|
||||||
| } | ||||||
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,31 @@ | ||
| # See https://aka.ms/customizecontainer to learn how to customize your debug container and how Visual Studio uses this Dockerfile to build your images for faster debugging. | ||
|
|
||
| # This stage is used when running from VS in fast mode (Default for Debug configuration) | ||
| FROM mcr.microsoft.com/dotnet/aspnet:8.0 AS base | ||
| USER app | ||
| WORKDIR /app | ||
| EXPOSE 8080 | ||
| EXPOSE 8081 | ||
|
|
||
|
|
||
| # This stage is used to build the service project | ||
| FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build | ||
| ARG BUILD_CONFIGURATION=Release | ||
| WORKDIR /src | ||
| COPY ["Examples/Directory.Build.props", "Examples/"] | ||
| COPY ["Examples/OSLC4NetExamples.Server.NetCoreApi/OSLC4NetExamples.Server.NetCoreApi.csproj", "Examples/OSLC4NetExamples.Server.NetCoreApi/"] | ||
| RUN dotnet restore "./Examples/OSLC4NetExamples.Server.NetCoreApi/OSLC4NetExamples.Server.NetCoreApi.csproj" | ||
| COPY . . | ||
| WORKDIR "/src/Examples/OSLC4NetExamples.Server.NetCoreApi" | ||
| RUN dotnet build "./OSLC4NetExamples.Server.NetCoreApi.csproj" -c $BUILD_CONFIGURATION -o /app/build | ||
|
|
||
| # This stage is used to publish the service project to be copied to the final stage | ||
| FROM build AS publish | ||
| ARG BUILD_CONFIGURATION=Release | ||
| RUN dotnet publish "./OSLC4NetExamples.Server.NetCoreApi.csproj" -c $BUILD_CONFIGURATION -o /app/publish /p:UseAppHost=false | ||
|
|
||
| # This stage is used in production or when running from VS in regular mode (Default when not using the Debug configuration) | ||
| FROM base AS final | ||
| WORKDIR /app | ||
| COPY --from=publish /app/publish . | ||
| ENTRYPOINT ["dotnet", "OSLC4NetExamples.Server.NetCoreApi.dll"] |
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,21 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk.Web"> | ||
|
|
||
| <PropertyGroup> | ||
| <TargetFramework>net8.0</TargetFramework> | ||
| <Nullable>enable</Nullable> | ||
| <ImplicitUsings>enable</ImplicitUsings> | ||
| <UserSecretsId>9d68bd64-651d-4baa-9904-6369c55b51cc</UserSecretsId> | ||
| <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS> | ||
| <DockerfileContext>..\..</DockerfileContext> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" /> | ||
| <PackageReference Include="Swashbuckle.AspNetCore" /> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\OSLC4Net.Server.Providers\OSLC4Net.Server.Providers.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,6 @@ | ||
| @OSLC4NetExamples.Server.NetCoreApi_HostAddress = http://localhost:5065 | ||
|
|
||
| GET {{OSLC4NetExamples.Server.NetCoreApi_HostAddress}}/weatherforecast/ | ||
| Accept: application/json | ||
|
|
||
| ### |
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,31 @@ | ||
| using OSLC4Net.Server.Providers; | ||
|
|
||
| var builder = WebApplication.CreateBuilder(args); | ||
|
|
||
| // Add services to the container. | ||
|
|
||
| builder.Services.AddControllers(options => | ||
| { | ||
| options.InputFormatters.Insert(0, new OslcRdfInputFormatter()); | ||
| options.OutputFormatters.Insert(0, new OslcRdfOutputFormatter()); | ||
| }); | ||
| // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle | ||
| builder.Services.AddEndpointsApiExplorer(); | ||
| builder.Services.AddSwaggerGen(); | ||
|
|
||
| var app = builder.Build(); | ||
|
|
||
| // Configure the HTTP request pipeline. | ||
| if (app.Environment.IsDevelopment()) | ||
| { | ||
| // app.UseSwagger(); | ||
| // app.UseSwaggerUI(); | ||
| } | ||
|
|
||
| app.UseHttpsRedirection(); | ||
|
|
||
| app.UseAuthorization(); | ||
|
|
||
| app.MapControllers(); | ||
|
Comment on lines
+25
to
+29
There was a problem hiding this comment. Enhance security and error handling middleware configuration. The current middleware setup has some potential gaps:
Consider adding these essential middleware components: app.UseHttpsRedirection();
+app.UseExceptionHandler("/error");
+app.UseHsts();
+
+// Configure CORS if needed
+app.UseCors();
+
+// Add authentication before authorization
+app.UseAuthentication();
app.UseAuthorization();
app.MapControllers();
|
||
|
|
||
| app.Run(); | ||
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,52 @@ | ||
| { | ||
| "profiles": { | ||
| "http": { | ||
| "commandName": "Project", | ||
| "launchBrowser": true, | ||
| "launchUrl": "swagger", | ||
| "environmentVariables": { | ||
| "ASPNETCORE_ENVIRONMENT": "Development" | ||
| }, | ||
| "dotnetRunMessages": true, | ||
| "applicationUrl": "http://localhost:5065" | ||
| }, | ||
| "https": { | ||
| "commandName": "Project", | ||
| "launchBrowser": true, | ||
| "launchUrl": "swagger", | ||
| "environmentVariables": { | ||
| "ASPNETCORE_ENVIRONMENT": "Development" | ||
| }, | ||
| "dotnetRunMessages": true, | ||
| "applicationUrl": "https://localhost:7270;http://localhost:5065" | ||
| }, | ||
| "IIS Express": { | ||
| "commandName": "IISExpress", | ||
| "launchBrowser": true, | ||
| "launchUrl": "swagger", | ||
| "environmentVariables": { | ||
| "ASPNETCORE_ENVIRONMENT": "Development" | ||
| } | ||
| }, | ||
| "Container (Dockerfile)": { | ||
| "commandName": "Docker", | ||
| "launchBrowser": true, | ||
| "launchUrl": "{Scheme}://{ServiceHost}:{ServicePort}/swagger", | ||
| "environmentVariables": { | ||
| "ASPNETCORE_HTTPS_PORTS": "8081", | ||
| "ASPNETCORE_HTTP_PORTS": "8080" | ||
| }, | ||
| "publishAllPorts": true, | ||
| "useSSL": true | ||
| } | ||
| }, | ||
| "$schema": "http://json.schemastore.org/launchsettings.json", | ||
| "iisSettings": { | ||
| "windowsAuthentication": false, | ||
| "anonymousAuthentication": true, | ||
| "iisExpress": { | ||
| "applicationUrl": "http://localhost:23478", | ||
| "sslPort": 44387 | ||
| } | ||
| } | ||
| } |
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,12 @@ | ||||||||||||||||||||||||||||||||||||||||||||||||||
| namespace OSLC4NetExamples.Server.NetCoreApi; | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| public class WeatherForecast | ||||||||||||||||||||||||||||||||||||||||||||||||||
| { | ||||||||||||||||||||||||||||||||||||||||||||||||||
| public DateOnly Date { get; set; } | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| public int TemperatureC { get; set; } | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| public int TemperatureF => 32 + (int)(TemperatureC / 0.5556); | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| public string? Summary { get; set; } | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+5
to
+11
There was a problem hiding this comment. 🛠️ Refactor suggestion Fix temperature conversion formula and add data validation. The current Celsius to Fahrenheit conversion formula uses an approximate division (0.5556). For better accuracy and maintainability:
- public DateOnly Date { get; set; }
+ public DateOnly Date { get; set; }
+
+ private int temperatureC;
+ public int TemperatureC
+ {
+ get => temperatureC;
+ set
+ {
+ if (value < -273) // Absolute zero in Celsius
+ throw new ArgumentOutOfRangeException(nameof(value), "Temperature cannot be below absolute zero");
+ temperatureC = value;
+ }
+ }
- public int TemperatureC { get; set; }
-
- public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+ public int TemperatureF => 32 + (int)(TemperatureC * 9.0 / 5.0);📝 Committable suggestion
Suggested change
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||||||||||||||||||||||||
|
Comment on lines
+1
to
+12
There was a problem hiding this comment. 💡 Codebase verification Replace WeatherForecast with OSLC-specific example models The WeatherForecast class and its controller are indeed template code from ASP.NET Core that should be replaced. The codebase contains rich OSLC-specific examples that would be more appropriate:
Consider replacing the WeatherForecast example with one of these domain-specific OSLC models to better demonstrate OSLC4Net functionality in the NetCoreApi example project. 🔗 Analysis chainVerify if this template code should be replaced with domain-specific models. This appears to be the default ASP.NET Core Web API template's WeatherForecast example. Consider whether this should be replaced with actual OSLC-specific domain models that demonstrate OSLC4Net functionality. 🏁 Scripts executedThe following scripts were executed for the analysis: Script: #!/bin/bash
# Check if this is just template code or if it's actually used in OSLC-specific examples
rg -l "WeatherForecast" | grep -v "Weather"
Length of output: 41 Script: #!/bin/bash
# Let's first check all files containing WeatherForecast without filtering
rg -l "WeatherForecast"
# Then check for any controllers or services using this model
ast-grep --pattern 'class $_ { $$$ WeatherForecast $$$ }'
# Check if there are any OSLC-specific models in the codebase that could serve as examples
fd -e cs -e java | xargs rg "OSLC" -l
Length of output: 17185 |
||||||||||||||||||||||||||||||||||||||||||||||||||
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
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.
Address OSLC implementation concerns.
The current OSLC endpoint implementation has several issues:
Consider implementing proper content negotiation:
[HttpGet] [Route("oslc")] +[Produces("application/rdf+xml", "application/ld+json")] public OSLC4Net.Core.Model.ServiceProvider Oslc() { var sp = new OSLC4Net.Core.Model.ServiceProvider(); - sp.SetAbout(new Uri(Request.GetEncodedUrl())); + // Use a configured base URL instead of raw request URL + sp.SetAbout(new Uri(Configuration["BaseUrl"] + Request.Path)); sp.SetDescription("test me"); + // Add required OSLC service definitions + sp.SetServices(CreateServiceDescriptions()); return sp; }