| | | 1 | | using Asp.Versioning; |
| | | 2 | | using Microsoft.AspNetCore.Mvc; |
| | | 3 | | using Microsoft.Extensions.Options; |
| | | 4 | | using ProjectTemplate.Web.Options; |
| | | 5 | | |
| | | 6 | | namespace ProjectTemplate.Web.Controllers.Api; |
| | | 7 | | |
| | | 8 | | /// <summary> |
| | | 9 | | /// Provides sample versioned API endpoints for the application. |
| | | 10 | | /// </summary> |
| | | 11 | | [ApiController] |
| | | 12 | | [ApiVersion("1.0")] |
| | | 13 | | [ApiVersion("0.9", Deprecated = true)] |
| | | 14 | | [Route("api/v{version:apiVersion}/application-information")] |
| | | 15 | | [Route("api/application-information")] |
| | | 16 | | public sealed class ApplicationInformationController( |
| | | 17 | | IOptions<ApplicationApiVersioningOptions> apiVersioningOptions) : ControllerBase |
| | | 18 | | { |
| | | 19 | | private const string _deprecationHeaderName = "Deprecation"; |
| | | 20 | | private const string _sunsetHeaderName = "Sunset"; |
| | | 21 | | |
| | | 22 | | private readonly ApplicationApiVersioningOptions _apiVersioningOptions = |
| | | 23 | | apiVersioningOptions?.Value ?? throw new ArgumentNullException(nameof(apiVersioningOptions)); |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Returns application API information for the requested API version. |
| | | 27 | | /// </summary> |
| | | 28 | | /// <returns>Application API version information.</returns> |
| | | 29 | | [HttpGet] |
| | | 30 | | public ActionResult<ApplicationInformationResponse> Get() |
| | | 31 | | { |
| | | 32 | | ApiVersion requestedVersion = HttpContext.Features |
| | | 33 | | .Get<IApiVersioningFeature>() |
| | | 34 | | ?.RequestedApiVersion ?? new ApiVersion(1, 0); |
| | | 35 | | |
| | | 36 | | if (requestedVersion.MajorVersion == 0 && requestedVersion.MinorVersion == 9) |
| | | 37 | | { |
| | | 38 | | AppendDeprecationHeaders(); |
| | | 39 | | } |
| | | 40 | | |
| | | 41 | | return Ok(new ApplicationInformationResponse( |
| | | 42 | | ApplicationName: "ProjectTemplate.Web", |
| | | 43 | | ApiVersion: FormatApiVersion(requestedVersion), |
| | | 44 | | Message: "API versioning foundation active.")); |
| | | 45 | | } |
| | | 46 | | |
| | | 47 | | private static string FormatApiVersion(ApiVersion version) |
| | | 48 | | { |
| | | 49 | | int minorVersion = version.MinorVersion ?? 0; |
| | | 50 | | |
| | | 51 | | return string.Create( |
| | | 52 | | System.Globalization.CultureInfo.InvariantCulture, |
| | | 53 | | $"{version.MajorVersion}.{minorVersion}"); |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | private void AppendDeprecationHeaders() |
| | | 57 | | { |
| | | 58 | | Response.Headers[_deprecationHeaderName] = "true"; |
| | | 59 | | Response.Headers.Link = "</api/v1/application-information>; rel=\"successor-version\""; |
| | | 60 | | |
| | | 61 | | // Sunset is advertised only when the application has configured a real removal date. A template cannot |
| | | 62 | | // supply one: a shipped date is arbitrary until it passes, and misleading afterwards. |
| | | 63 | | if (_apiVersioningOptions.DeprecatedVersionSunset is DateTimeOffset sunsetDate) |
| | | 64 | | { |
| | | 65 | | Response.Headers[_sunsetHeaderName] = |
| | | 66 | | sunsetDate.ToString("R", System.Globalization.CultureInfo.InvariantCulture); |
| | | 67 | | } |
| | | 68 | | } |
| | | 69 | | } |
| | | 70 | | |
| | | 71 | | /// <summary> |
| | | 72 | | /// Represents sample application API information. |
| | | 73 | | /// </summary> |
| | | 74 | | /// <param name="ApplicationName">The application name.</param> |
| | | 75 | | /// <param name="ApiVersion">The resolved API version.</param> |
| | | 76 | | /// <param name="Message">A short status message.</param> |
| | 6 | 77 | | public sealed record ApplicationInformationResponse( |
| | 6 | 78 | | string ApplicationName, |
| | 6 | 79 | | string ApiVersion, |
| | 6 | 80 | | string Message); |