Skip to content

Throw at startup when different OpenAPI version is loaded #1819

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
merged 1 commit into from
Oct 21, 2025
Merged

Throw at startup when different OpenAPI version is loaded #1819

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
38 changes: 31 additions & 7 deletions src/JsonApiDotNetCore/Configuration/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System.Reflection;
using JetBrains.Annotations;
using JsonApiDotNetCore.Errors;
using JsonApiDotNetCore.Repositories;
Expand All @@ -13,6 +14,16 @@ public static class ServiceCollectionExtensions
{
private static readonly TypeLocator TypeLocator = new();

/// <summary>
/// Configures JsonApiDotNetCore by registering resources from an Entity Framework Core model.
/// </summary>
public static IServiceCollection AddJsonApi<TDbContext>(this IServiceCollection services, Action<JsonApiOptions>? options = null,
Action<ServiceDiscoveryFacade>? discovery = null, Action<ResourceGraphBuilder>? resources = null, IMvcCoreBuilder? mvcBuilder = null)
where TDbContext : DbContext
{
return AddJsonApi(services, options, discovery, resources, mvcBuilder, [typeof(TDbContext)]);
}

/// <summary>
/// Configures JsonApiDotNetCore by registering resources manually.
/// </summary>
Expand All @@ -23,20 +34,33 @@ public static IServiceCollection AddJsonApi(this IServiceCollection services, Ac
#pragma warning restore AV1553 // Do not use optional parameters with default value null for strings, collections or tasks
{
ArgumentNullException.ThrowIfNull(services);
AssertCompatibleOpenApiVersion();

SetupApplicationBuilder(services, options, discovery, resources, mvcBuilder, dbContextTypes ?? Array.Empty<Type>());

return services;
}

/// <summary>
/// Configures JsonApiDotNetCore by registering resources from an Entity Framework Core model.
/// </summary>
public static IServiceCollection AddJsonApi<TDbContext>(this IServiceCollection services, Action<JsonApiOptions>? options = null,
Action<ServiceDiscoveryFacade>? discovery = null, Action<ResourceGraphBuilder>? resources = null, IMvcCoreBuilder? mvcBuilder = null)
where TDbContext : DbContext
private static void AssertCompatibleOpenApiVersion()
{
return AddJsonApi(services, options, discovery, resources, mvcBuilder, [typeof(TDbContext)]);
Version thisAssemblyVersion = typeof(IJsonApiOptions).Assembly.GetName().Version!;
Version? openApiAssemblyVersion = TryGetOpenApiAssemblyVersion();

if (openApiAssemblyVersion != null && openApiAssemblyVersion != thisAssemblyVersion)
{
throw new InvalidOperationException(
$"JsonApiDotNetCore v{thisAssemblyVersion.ToString(3)} is incompatible with JsonApiDotNetCore.OpenApi.Swashbuckle v{openApiAssemblyVersion.ToString(3)}. " +
$"Reference a matching (preview) version of the JsonApiDotNetCore.OpenApi.Swashbuckle NuGet package.");
}
}

private static Version? TryGetOpenApiAssemblyVersion()
{
Assembly? openApiAssembly = AppDomain.CurrentDomain.GetAssemblies().FirstOrDefault(assembly =>
assembly.FullName?.StartsWith("JsonApiDotNetCore.OpenApi.Swashbuckle", StringComparison.Ordinal) == true &&
assembly.GetName().Name == "JsonApiDotNetCore.OpenApi.Swashbuckle");

return openApiAssembly?.GetType("JsonApiDotNetCore.OpenApi.Swashbuckle.ServiceCollectionExtensions", false)?.Assembly.GetName().Version;
}

private static void SetupApplicationBuilder(IServiceCollection services, Action<JsonApiOptions>? configureOptions,
Expand Down