Skip to content

fix: dotnet 10 openapi #261

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hhvrc merged 1 commit into from
Dec 22, 2025
+28 −18
Merged

fix: dotnet 10 openapi #261

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 19 additions & 11 deletions Common/OpenAPI/OpenApiExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
using Microsoft.OpenApi;
using Asp.Versioning.ApiExplorer;
using Microsoft.OpenApi;

namespace OpenShock.Common.OpenAPI;

Expand All @@ -16,16 +17,23 @@ public static IServiceCollection AddOpenApiExt<TProgram>(this WebApplicationBuil
{
options.AddPolicy("OpenAPI", policy => policy.Expire(TimeSpan.FromMinutes(10)));
});
builder.Services.AddOpenApi(options =>
{
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
options.AddDocumentTransformer(DocumentDefaults.GetDocumentTransformer(version: "1"));
});
builder.Services.AddOpenApi("v2", options =>

using (var tempProvider = builder.Services.BuildServiceProvider())
{
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
options.AddDocumentTransformer(DocumentDefaults.GetDocumentTransformer(version: "2"));
});
var apiVersionProvider = tempProvider.GetRequiredService<IApiVersionDescriptionProvider>();

// Configure OpenAPI for each API version
foreach (var description in apiVersionProvider.ApiVersionDescriptions)
{
builder.Services.AddOpenApi(description.GroupName, options =>
{
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
options.AddDocumentTransformer(DocumentDefaults.GetDocumentTransformer(
version: description.ApiVersion.ToString()));
});
}
}

builder.Services.AddOpenApi("oauth", options =>
{
options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
Expand All @@ -38,7 +46,7 @@ public static IServiceCollection AddOpenApiExt<TProgram>(this WebApplicationBuil
options.ShouldInclude = apiDescription => apiDescription.GroupName is "admin";
options.AddDocumentTransformer(DocumentDefaults.GetDocumentTransformer(version: "1"));
});

return builder.Services;
}
}
6 changes: 3 additions & 3 deletions Common/OpenShockMiddlewareHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ public static async Task<IApplicationBuilder> UseCommonOpenShockMiddleware(this

app.MapScalarApiReference("/scalar/viewer", options =>
options
.WithOpenApiRoutePattern("/swagger/{documentName}/swagger.json")
.AddDocument("1", "Version 1")
.AddDocument("2", "Version 2")
.WithOpenApiRoutePattern("/openapi/{documentName}.json")
.AddDocument("v1", "Version 1")
.AddDocument("v2", "Version 2")
);

app.MapControllers();
Expand Down
10 changes: 6 additions & 4 deletions Common/OpenShockServiceHelper.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,13 @@ public static IServiceCollection AddOpenShockServices(this IServiceCollection se
{
options.DefaultApiVersion = new ApiVersion(1, 0);
options.AssumeDefaultVersionWhenUnspecified = true;
});

apiVersioningBuilder.AddApiExplorer(setup =>
options.ReportApiVersions = true;
options.ApiVersionReader = new UrlSegmentApiVersionReader();
})
.AddMvc() // mvc required for ApiExplorer
.AddApiExplorer(setup =>
{
setup.GroupNameFormat = "VVV";
setup.GroupNameFormat = "'v'V";
setup.SubstituteApiVersionInUrl = true;
setup.DefaultApiVersion = new ApiVersion(1, 0);
setup.AssumeDefaultVersionWhenUnspecified = true;
Expand Down