| | | 1 | | using Asp.Versioning; |
| | | 2 | | using ProjectTemplate.Web.Options; |
| | | 3 | | |
| | | 4 | | namespace ProjectTemplate.Web.Extensions; |
| | | 5 | | |
| | | 6 | | /// <summary> |
| | | 7 | | /// Provides extension methods to register API versioning services for the application. |
| | | 8 | | /// </summary> |
| | | 9 | | public static class ApiVersioningServiceExtensions |
| | | 10 | | { |
| | | 11 | | /// <summary> |
| | | 12 | | /// Adds API versioning services and conventions for controller-based APIs. |
| | | 13 | | /// </summary> |
| | | 14 | | /// <param name="services">The service collection to configure.</param> |
| | | 15 | | /// <param name="configuration">The application configuration source.</param> |
| | | 16 | | /// <returns>The same service collection instance so calls can be chained.</returns> |
| | | 17 | | public static IServiceCollection AddApplicationApiVersioning( |
| | | 18 | | this IServiceCollection services, |
| | | 19 | | IConfiguration configuration) |
| | | 20 | | { |
| | 117 | 21 | | ApplicationApiVersioningOptions apiVersioningOptions = new(); |
| | | 22 | | |
| | 117 | 23 | | configuration |
| | 117 | 24 | | .GetSection(ApplicationApiVersioningOptions.SectionName) |
| | 117 | 25 | | .Bind(apiVersioningOptions); |
| | | 26 | | |
| | 117 | 27 | | ValidateApiVersioningOptions(apiVersioningOptions); |
| | | 28 | | |
| | 113 | 29 | | services |
| | 113 | 30 | | .AddOptions<ApplicationApiVersioningOptions>() |
| | 113 | 31 | | .Bind(configuration.GetSection(ApplicationApiVersioningOptions.SectionName)) |
| | 113 | 32 | | .Validate(options => options.DefaultMajorVersion > 0, |
| | 113 | 33 | | "ProjectTemplate:ApiVersioning:DefaultMajorVersion must be greater than zero.") |
| | 113 | 34 | | .Validate(options => options.DefaultMinorVersion >= 0, |
| | 113 | 35 | | "ProjectTemplate:ApiVersioning:DefaultMinorVersion must be zero or greater.") |
| | 113 | 36 | | .Validate(options => options.EnableUrlSegmentVersioning || options.EnableHeaderVersioning, |
| | 113 | 37 | | "ProjectTemplate:ApiVersioning must enable URL segment versioning, header versioning, or both.") |
| | 113 | 38 | | .Validate(options => !options.EnableHeaderVersioning || !string.IsNullOrWhiteSpace(options.HeaderName), |
| | 113 | 39 | | "ProjectTemplate:ApiVersioning:HeaderName is required when header versioning is enabled.") |
| | 113 | 40 | | .ValidateOnStart(); |
| | | 41 | | |
| | 113 | 42 | | IApiVersionReader[] readers = CreateApiVersionReaders(apiVersioningOptions); |
| | | 43 | | |
| | 113 | 44 | | services |
| | 113 | 45 | | .AddApiVersioning(options => |
| | 113 | 46 | | { |
| | 113 | 47 | | options.DefaultApiVersion = new ApiVersion( |
| | 113 | 48 | | apiVersioningOptions.DefaultMajorVersion, |
| | 113 | 49 | | apiVersioningOptions.DefaultMinorVersion); |
| | 113 | 50 | | |
| | 113 | 51 | | options.AssumeDefaultVersionWhenUnspecified = |
| | 113 | 52 | | apiVersioningOptions.AssumeDefaultVersionWhenUnspecified; |
| | 113 | 53 | | |
| | 113 | 54 | | options.ReportApiVersions = apiVersioningOptions.ReportApiVersions; |
| | 113 | 55 | | options.ApiVersionReader = ApiVersionReader.Combine(readers); |
| | 113 | 56 | | }) |
| | 113 | 57 | | .AddMvc(); |
| | | 58 | | |
| | 113 | 59 | | return services; |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | private static IApiVersionReader[] CreateApiVersionReaders( |
| | | 63 | | ApplicationApiVersioningOptions options) |
| | | 64 | | { |
| | 113 | 65 | | List<IApiVersionReader> readers = []; |
| | | 66 | | |
| | 113 | 67 | | if (options.EnableUrlSegmentVersioning) |
| | | 68 | | { |
| | 112 | 69 | | readers.Add(new UrlSegmentApiVersionReader()); |
| | | 70 | | } |
| | | 71 | | |
| | 113 | 72 | | if (options.EnableHeaderVersioning) |
| | | 73 | | { |
| | 112 | 74 | | readers.Add(new HeaderApiVersionReader(options.HeaderName)); |
| | | 75 | | } |
| | | 76 | | |
| | 113 | 77 | | return [.. readers]; |
| | | 78 | | } |
| | | 79 | | |
| | | 80 | | private static void ValidateApiVersioningOptions(ApplicationApiVersioningOptions options) |
| | | 81 | | { |
| | 117 | 82 | | if (options.DefaultMajorVersion <= 0) |
| | | 83 | | { |
| | 1 | 84 | | throw new InvalidOperationException( |
| | 1 | 85 | | "ProjectTemplate:ApiVersioning:DefaultMajorVersion must be greater than zero."); |
| | | 86 | | } |
| | | 87 | | |
| | 116 | 88 | | if (options.DefaultMinorVersion < 0) |
| | | 89 | | { |
| | 1 | 90 | | throw new InvalidOperationException( |
| | 1 | 91 | | "ProjectTemplate:ApiVersioning:DefaultMinorVersion must be zero or greater."); |
| | | 92 | | } |
| | | 93 | | |
| | 115 | 94 | | if (!options.EnableUrlSegmentVersioning && !options.EnableHeaderVersioning) |
| | | 95 | | { |
| | 1 | 96 | | throw new InvalidOperationException( |
| | 1 | 97 | | "ProjectTemplate:ApiVersioning must enable URL segment versioning, header versioning, or both."); |
| | | 98 | | } |
| | | 99 | | |
| | 114 | 100 | | if (options.EnableHeaderVersioning && string.IsNullOrWhiteSpace(options.HeaderName)) |
| | | 101 | | { |
| | 1 | 102 | | throw new InvalidOperationException( |
| | 1 | 103 | | "ProjectTemplate:ApiVersioning:HeaderName is required when header versioning is enabled."); |
| | | 104 | | } |
| | 113 | 105 | | } |
| | | 106 | | } |