| | | 1 | | using Microsoft.AspNetCore.Mvc.ApiExplorer; |
| | | 2 | | using Microsoft.Extensions.DependencyInjection; |
| | | 3 | | using Microsoft.Extensions.Options; |
| | | 4 | | using Microsoft.OpenApi; |
| | | 5 | | using Plainquire.Sort.Abstractions; |
| | | 6 | | using Plainquire.Sort.Swashbuckle.Models; |
| | | 7 | | using Swashbuckle.AspNetCore.SwaggerGen; |
| | | 8 | | using System; |
| | | 9 | | using System.Collections.Generic; |
| | | 10 | | using System.Diagnostics.CodeAnalysis; |
| | | 11 | | using System.Linq; |
| | | 12 | | |
| | | 13 | | namespace Plainquire.Sort.Swashbuckle.Filters; |
| | | 14 | | |
| | | 15 | | /// <summary> |
| | | 16 | | /// Replaces action parameters of type <see cref="EntitySort"/> with sortable properties of type <c>TEntity</c>. |
| | | 17 | | /// Implements <see cref="IOperationFilter" /> |
| | | 18 | | /// </summary> |
| | | 19 | | /// <seealso cref="IOperationFilter" /> |
| | | 20 | | [SuppressMessage("ReSharper", "ClassNeverInstantiated.Global", Justification = "Instantiated via DI.")] |
| | | 21 | | public class EntitySortParameterReplacer : IOperationFilter |
| | | 22 | | { |
| | | 23 | | private readonly IServiceProvider _serviceProvider; |
| | | 24 | | private readonly SortConfiguration _defaultConfiguration; |
| | | 25 | | |
| | | 26 | | /// <summary> |
| | | 27 | | /// Initializes a new instance of the <see cref="EntitySortParameterReplacer"/> class. |
| | | 28 | | /// </summary> |
| | | 29 | | /// <param name="serviceProvider"></param> |
| | | 30 | | public EntitySortParameterReplacer(IServiceProvider serviceProvider) |
| | | 31 | | { |
| | 32 | 32 | | _serviceProvider = serviceProvider; |
| | 32 | 33 | | _defaultConfiguration = _serviceProvider.GetService<IOptions<SortConfiguration>>()?.Value ?? SortConfiguration.D |
| | 32 | 34 | | } |
| | | 35 | | |
| | | 36 | | /// <summary> |
| | | 37 | | /// Replaces all parameters of type <see cref="EntitySort{TEntity}"/> with their applicable sort order properties. |
| | | 38 | | /// </summary> |
| | | 39 | | /// <param name="operation">The operation.</param> |
| | | 40 | | /// <param name="context">The context.</param> |
| | | 41 | | public void Apply(OpenApiOperation operation, OperationFilterContext context) |
| | | 42 | | { |
| | 29 | 43 | | operation.Parameters ??= new List<IOpenApiParameter>(); |
| | 29 | 44 | | var parametersToReplace = operation.Parameters |
| | 29 | 45 | | .Join( |
| | 29 | 46 | | context.ApiDescription.ParameterDescriptions, |
| | 29 | 47 | | parameter => parameter.Name, |
| | 29 | 48 | | description => description.Name, |
| | 29 | 49 | | (parameter, description) => (Parameter: parameter, Description: description), |
| | 29 | 50 | | StringComparer.OrdinalIgnoreCase |
| | 29 | 51 | | ) |
| | 29 | 52 | | .Where(openApi => IsEntitySortParameter(openApi.Description)) |
| | 29 | 53 | | .Select(openApi => |
| | 29 | 54 | | { |
| | 29 | 55 | | var entitySortType = openApi.Description.ParameterDescriptor.ParameterType; |
| | 29 | 56 | | var configuration = GetConfiguration(entitySortType); |
| | 29 | 57 | | return new SortParameterReplacement( |
| | 29 | 58 | | OpenApiParameter: openApi.Parameter, |
| | 29 | 59 | | OpenApiDescription: openApi.Description, |
| | 29 | 60 | | SortedType: entitySortType.GenericTypeArguments[0], |
| | 29 | 61 | | Configuration: configuration); |
| | 29 | 62 | | }) |
| | 29 | 63 | | .ToList(); |
| | | 64 | | |
| | 29 | 65 | | operation.ReplaceSortParameters(parametersToReplace); |
| | 29 | 66 | | } |
| | | 67 | | |
| | | 68 | | [SuppressMessage("ReSharper", "ConditionIsAlwaysTrueOrFalseAccordingToNullableAPIContract", Justification = "Paramet |
| | | 69 | | private static bool IsEntitySortParameter(ApiParameterDescription description) |
| | 106 | 70 | | => description.ParameterDescriptor != null && description.ParameterDescriptor.ParameterType.IsGenericEntitySort( |
| | | 71 | | |
| | | 72 | | private SortConfiguration GetConfiguration(Type entitySortType) |
| | | 73 | | { |
| | 45 | 74 | | if (!entitySortType.IsGenericEntitySort()) |
| | 0 | 75 | | throw new ArgumentException("Type is not an EntitySort<>", nameof(entitySortType)); |
| | | 76 | | |
| | 45 | 77 | | var entityTypeConfiguration = ((EntitySort?)_serviceProvider.GetService(entitySortType))?.Configuration; |
| | 45 | 78 | | return entityTypeConfiguration ?? _defaultConfiguration; |
| | | 79 | | } |
| | | 80 | | } |