Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<TargetFramework>net11.0</TargetFramework>
<AssemblyTitle>Example API</AssemblyTitle>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<TargetFramework>net11.0</TargetFramework>
<AssemblyTitle>Example API</AssemblyTitle>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<TargetFramework>net11.0</TargetFramework>
<AssemblyTitle>Example API</AssemblyTitle>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand All @@ -13,6 +13,12 @@
</PackageReference>
<PackageReference Include="Scalar.AspNetCore" />
<PackageReference Include="Scalar.AspNetCore.Microsoft" />

<!-- Scalar package above brings Microsoft.AspNetCore.OpenApi 10 whose source gen doesn't work with latest Microsoft.OpenApi -->
<!-- The latest preview of Microsoft.AspNetCore.OpenApi has the fixed source gen. -->
<PackageReference Include="Microsoft.AspNetCore.OpenApi" />

<Reference Include="Microsoft.AspNetCore.OpenApi.dll" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project Sdk="Microsoft.NET.Sdk.Web">

<PropertyGroup>
<TargetFramework>net10.0</TargetFramework>
<TargetFramework>net11.0</TargetFramework>
<AssemblyTitle>Example API</AssemblyTitle>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
Expand Down
3 changes: 2 additions & 1 deletion examples/Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@

<ItemGroup Label="ASP.NET Core">
<PackageVersion Include="Microsoft.AspNetCore.OData" Version="10.0.0-preview.2" />
<PackageVersion Include="Microsoft.Extensions.ApiDescription.Server" Version="10.0.3" />
<PackageVersion Include="Microsoft.Extensions.ApiDescription.Server" Version="11.0.0-preview.4.26230.115" />
<PackageVersion Include="Scalar.AspNetCore" Version="2.12.46" />
<PackageVersion Include="Scalar.AspNetCore.Microsoft" Version="2.12.46" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="11.0.0-preview.4.26230.115" />
</ItemGroup>

</Project>
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,9 @@ public void applies_to_endpoints_should_return_true_for_service_document()
var paramSource = Mock.Of<IApiVersionParameterSource>();
var options = Options.Create( new ApiVersioningOptions() );
var policy = new DefaultMetadataMatcherPolicy( paramSource, options );
#pragma warning disable CA1825 // Avoid zero-length array allocations
var metadata = new ODataRoutingMetadata( string.Empty, EdmCoreModel.Instance, [] );
#pragma warning restore CA1825 // Avoid zero-length array allocations
var items = new object[] { metadata };
var endpoints = new Endpoint[] { new( Limbo, new( items ), default ) };

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<VersionPrefix>10.0.0</VersionPrefix>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<TargetFramework>$(DefaultTargetFramework)</TargetFramework>
<VersionPrefix>11.0.0</VersionPrefix>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
<TargetFramework>net11.0</TargetFramework>
<RootNamespace>Asp.Versioning.OpenApi</RootNamespace>
<AssemblyTitle>ASP.NET Core API Versioning</AssemblyTitle>
<Description>The OpenAPI extensions for ASP.NET Core API Versioning.</Description>
Expand All @@ -16,8 +16,9 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.OpenApi" Version="2.0.0" />
<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.*" />
<PackageReference Include="Microsoft.OpenApi" Version="3.3.1" />
<!--<PackageReference Include="Microsoft.AspNetCore.OpenApi" Version="10.0.*" />-->
<Reference Include="Microsoft.AspNetCore.OpenApi.dll" />
</ItemGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,6 @@

namespace Microsoft.AspNetCore.Builder;

using Asp.Versioning;
using Asp.Versioning.ApiExplorer;
using Asp.Versioning.OpenApi.Reflection;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;

/// <summary>
/// Provides extension methods for <see cref="IEndpointConventionBuilder"/>.
/// </summary>
Expand All @@ -29,27 +22,7 @@ public static class IEndpointConventionBuilderExtensions
/// <returns>The original <see cref="IEndpointConventionBuilder">endpoint convention builder</see>.</returns>
public IEndpointConventionBuilder WithDocumentPerVersion()
{
builder.Finally( ApplyApiVersioning );
return builder;
}
}

private static void ApplyApiVersioning( EndpointBuilder builder )
{
if ( builder.RequestDelegate is { } action )
{
builder.RequestDelegate = context => InterceptRequestServices( context, action );
}
}

private static Task InterceptRequestServices( HttpContext context, RequestDelegate action )
{
if ( context.RequestServices is not KeyedServiceContainer requestServices )
{
requestServices = context.RequestServices.GetRequiredService<KeyedServiceContainer>();
}

context.RequestServices = requestServices;
return action( context );
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
namespace Asp.Versioning.OpenApi.Configuration;

using Asp.Versioning.ApiExplorer;
using Asp.Versioning.OpenApi.Reflection;
using Asp.Versioning.OpenApi.Transformers;
using Microsoft.AspNetCore.OpenApi;
using Microsoft.Extensions.Options;
Expand Down Expand Up @@ -48,7 +47,6 @@ private static void Configure( VersionedOpenApiOptions versionedOptions, XmlComm
var options = versionedOptions.Document;
var apiExplorer = new ApiExplorerTransformer( versionedOptions );

options.SetDocumentName( versionedOptions.Description.GroupName );
options.AddDocumentTransformer( apiExplorer );
options.AddSchemaTransformer( apiExplorer );
options.AddOperationTransformer( apiExplorer );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@ namespace Microsoft.Extensions.DependencyInjection;
using Asp.Versioning.ApiExplorer;
using Asp.Versioning.OpenApi;
using Asp.Versioning.OpenApi.Configuration;
using Asp.Versioning.OpenApi.Reflection;
using Asp.Versioning.OpenApi.Transformers;
using Microsoft.AspNetCore.Http.Json;
using Microsoft.AspNetCore.OpenApi;
using Microsoft.AspNetCore.OpenApi.Extensions;
using Microsoft.Extensions.DependencyInjection.Extensions;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Options;
Expand Down Expand Up @@ -64,18 +63,13 @@ private static void AddOpenApiServices( IApiVersioningBuilder builder, Assembly[

var services = builder.Services;

services.AddTransient( NewRequestServices );
services.Add( Singleton( Type.IDocumentProvider, ResolveDocumentProvider ) );
services.AddSingleton<IAdditionalOpenApiDocumentNameProvider, OpenApiVersionedDocumentNamesProvider>();
services.AddSingleton<VersionedOpenApiOptionsFactory>();
services.AddOpenApi(documentName: null);
services.TryAddEnumerable( Transient<IPostConfigureOptions<OpenApiOptions>, ConfigureOpenApiOptions>() );
services.TryAdd( Singleton<IOptionsFactory<VersionedOpenApiOptions>>( EM.GetRequiredService<VersionedOpenApiOptionsFactory> ) );
services.AddTransient( sp => new XmlCommentsFile( assemblies, sp.GetRequiredService<IHostEnvironment>() ) );
services.TryAddTransient( sp => new XmlCommentsTransformer( sp.GetRequiredService<XmlCommentsFile>() ) );

if ( GetJsonConfiguration() is { } descriptor )
{
services.TryAddEnumerable( descriptor );
}
}

// NOTE: The calling assembly must be captured at the call site that invokes AddOpenApi. In 99% of the cases that
Expand All @@ -93,56 +87,4 @@ private static Assembly[] GetAssemblies( Assembly callingAssembly )

return [.. assemblies];
}

// HACK: the json configuration is internal; this approach negates the use of reflection
// REF: https://github.com/dotnet/aspnetcore/blob/08a9fc2c3864d99759ab3d71cfda868d852bfc4b/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs#L121
private static ServiceDescriptor? GetJsonConfiguration()
{
var services = new ServiceCollection();
services.AddOpenApi( "*" );
return services.SingleOrDefault( sd => sd.ServiceType == typeof( IConfigureOptions<JsonOptions> ) );
}

private static object ResolveDocumentProvider( IServiceProvider provider ) =>
provider.GetRequiredService<KeyedServiceContainer>().GetRequiredService( Type.IDocumentProvider );

[UnconditionalSuppressMessage( "ILLink", "IL3050" )]
private static KeyedServiceContainer NewRequestServices( IServiceProvider services )
{
var provider = services.GetRequiredService<IApiVersionDescriptionProvider>();
var container = new KeyedServiceContainer( services );
var type = typeof( IOpenApiDocumentProvider );
var descriptions = provider.ApiVersionDescriptions;
var names = new List<string>( descriptions.Count );

for ( var i = 0; i < descriptions.Count; i++ )
{
var description = descriptions[i];

// REF: https://github.com/dotnet/aspnetcore/blob/319e87fd950a99f3baae2aa79db3d4fb68783d85/src/OpenApi/src/Extensions/OpenApiServiceCollectionExtensions.cs#L64
#pragma warning disable CA1308 // Normalize strings to uppercase
var key = description.GroupName.ToLowerInvariant();
#pragma warning restore CA1308

names.Add( key );
container.AddService( Type.OpenApiSchemaService, key, Class.OpenApiSchemaService.New );
container.AddService( Type.OpenApiDocumentService, key, Class.OpenApiDocumentService.New );
container.AddService( type, key, ( sp, k ) => sp.GetRequiredKeyedService( Type.OpenApiDocumentService, k ) );
}

if ( names.Count > 0 )
{
var array = Array.CreateInstance( Type.NamedService, names.Count );

for ( var i = 0; i < names.Count; i++ )
{
array.SetValue( Class.NamedService.New( names[i] ), i );
}

container.AddService( Type.IDocumentProvider, Class.OpenApiDocumentProvider.New );
container.AddService( Type.IEnumerableOfNamedService, array );
}

return container;
}
}

This file was deleted.

Binary file not shown.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Copyright (c) .NET Foundation and contributors. All rights reserved.

namespace Asp.Versioning.OpenApi;

using Asp.Versioning.ApiExplorer;
using Microsoft.AspNetCore.OpenApi.Extensions;

#pragma warning disable

internal sealed class OpenApiVersionedDocumentNamesProvider : IAdditionalOpenApiDocumentNameProvider
{
private readonly IApiVersionDescriptionProvider provider;

public OpenApiVersionedDocumentNamesProvider( IApiVersionDescriptionProvider provider )
{
this.provider = provider;
}

public IEnumerable<string> DocumentNames
{
get
{
var descriptions = provider.ApiVersionDescriptions;
var names = new string[descriptions.Count];
for (var i = 0; i < names.Length; i++)
{
names[i] = descriptions[i].GroupName;
}

return names;
}
}
}
Loading
Loading