| | | 1 | | using Microsoft.AspNetCore.Mvc.Abstractions; |
| | | 2 | | using Microsoft.OpenApi.Any; |
| | | 3 | | using Microsoft.OpenApi.Interfaces; |
| | | 4 | | using Microsoft.OpenApi.Models; |
| | | 5 | | using Plainquire.Page.Swashbuckle.Models; |
| | | 6 | | using System; |
| | | 7 | | using System.Collections.Generic; |
| | | 8 | | using System.Linq; |
| | | 9 | | |
| | | 10 | | namespace Plainquire.Page.Swashbuckle; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Extension methods for <see cref="OpenApiOperation"/>. |
| | | 14 | | /// </summary> |
| | | 15 | | public static class OpenApiOperationExtensions |
| | | 16 | | { |
| | | 17 | | private const string ENTITY_PAGE_EXTENSION = "x-entity-page"; |
| | | 18 | | private const string ENTITY_DELETE_EXTENSION = "x-entity-page-delete"; |
| | | 19 | | |
| | | 20 | | |
| | | 21 | | /// <summary> |
| | | 22 | | /// Replaces <see cref="EntityPage{TEntity}"/> and with the sort parameters. |
| | | 23 | | /// </summary> |
| | | 24 | | /// <param name="operation">The <see cref="OpenApiOperation"/> to operate on.</param> |
| | | 25 | | /// <param name="parametersToReplace">The parameters to replace.</param> |
| | | 26 | | public static void ReplacePageParameters(this OpenApiOperation operation, IList<PageParameterReplacement> parameters |
| | | 27 | | { |
| | 23 | 28 | | MarkExistingParametersForDeletion(parametersToReplace); |
| | 23 | 29 | | ReplacePageNumberParameters(operation, parametersToReplace); |
| | 23 | 30 | | ReplacePageSizeParameters(operation, parametersToReplace); |
| | 23 | 31 | | RemoveParametersMarkedForDeletion(operation); |
| | 23 | 32 | | } |
| | | 33 | | |
| | | 34 | | private static void ReplacePageNumberParameters(OpenApiOperation operation, IList<PageParameterReplacement> paramete |
| | | 35 | | { |
| | 23 | 36 | | var httpQueryParameterGroup = GroupByPageNumberHttpQueryParameterName(parametersToReplace); |
| | 106 | 37 | | foreach (var (queryParameter, parameters) in httpQueryParameterGroup) |
| | | 38 | | { |
| | 30 | 39 | | var openApiParameter = new OpenApiParameter |
| | 30 | 40 | | { |
| | 30 | 41 | | Name = queryParameter, |
| | 30 | 42 | | Description = "Pages the result by the given page number.", |
| | 30 | 43 | | Schema = new OpenApiSchema |
| | 30 | 44 | | { |
| | 30 | 45 | | Type = "integer", |
| | 30 | 46 | | Format = "int32" |
| | 30 | 47 | | }, |
| | 30 | 48 | | In = ParameterLocation.Query, |
| | 30 | 49 | | Extensions = new Dictionary<string, IOpenApiExtension>(StringComparer.Ordinal) |
| | 30 | 50 | | { |
| | 30 | 51 | | [ENTITY_PAGE_EXTENSION] = new OpenApiBoolean(true) |
| | 30 | 52 | | } |
| | 30 | 53 | | }; |
| | | 54 | | |
| | 30 | 55 | | var insertionIndex = operation.Parameters.IndexOf(parameters[0].OpenApiParameter); |
| | 30 | 56 | | operation.Parameters.Insert(insertionIndex, openApiParameter); |
| | | 57 | | } |
| | 23 | 58 | | } |
| | | 59 | | |
| | | 60 | | private static void ReplacePageSizeParameters(OpenApiOperation operation, IList<PageParameterReplacement> parameters |
| | | 61 | | { |
| | 23 | 62 | | var httpQueryParameterGroup = GroupByPageSizeHttpQueryParameterName(parametersToReplace); |
| | 104 | 63 | | foreach (var (queryParameter, parameters) in httpQueryParameterGroup) |
| | | 64 | | { |
| | 29 | 65 | | var openApiParameter = new OpenApiParameter |
| | 29 | 66 | | { |
| | 29 | 67 | | Name = queryParameter, |
| | 29 | 68 | | Description = "Pages the result by the given page size.", |
| | 29 | 69 | | Schema = new OpenApiSchema |
| | 29 | 70 | | { |
| | 29 | 71 | | Type = "integer", |
| | 29 | 72 | | Format = "int32" |
| | 29 | 73 | | }, |
| | 29 | 74 | | In = ParameterLocation.Query, |
| | 29 | 75 | | Extensions = new Dictionary<string, IOpenApiExtension>(StringComparer.Ordinal) |
| | 29 | 76 | | { |
| | 29 | 77 | | [ENTITY_PAGE_EXTENSION] = new OpenApiBoolean(true) |
| | 29 | 78 | | } |
| | 29 | 79 | | }; |
| | | 80 | | |
| | 29 | 81 | | var insertionIndex = operation.Parameters.IndexOf(parameters[0].OpenApiParameter); |
| | 29 | 82 | | operation.Parameters.Insert(insertionIndex, openApiParameter); |
| | | 83 | | } |
| | 23 | 84 | | } |
| | | 85 | | |
| | | 86 | | private static Dictionary<string, List<PageParameterReplacement>> GroupByPageNumberHttpQueryParameterName(IList<Page |
| | 23 | 87 | | => parametersToReplace |
| | 23 | 88 | | .GroupBy(parameter => GetPageNumberParameterName(parameter.OpenApiDescription.ParameterDescriptor), StringCo |
| | 23 | 89 | | .ToDictionary( |
| | 23 | 90 | | group => group.Key, |
| | 23 | 91 | | group => group.ToList(), |
| | 23 | 92 | | StringComparer.Ordinal |
| | 23 | 93 | | ); |
| | | 94 | | |
| | | 95 | | private static Dictionary<string, List<PageParameterReplacement>> GroupByPageSizeHttpQueryParameterName(IList<PagePa |
| | 23 | 96 | | => parametersToReplace |
| | 23 | 97 | | .GroupBy(parameter => GetPageSizeParameterName(parameter.OpenApiDescription.ParameterDescriptor), StringComp |
| | 23 | 98 | | .ToDictionary( |
| | 23 | 99 | | group => group.Key, |
| | 23 | 100 | | group => group.ToList(), |
| | 23 | 101 | | StringComparer.Ordinal |
| | 23 | 102 | | ); |
| | | 103 | | |
| | | 104 | | private static void MarkExistingParametersForDeletion(IList<PageParameterReplacement> parameters) |
| | | 105 | | { |
| | 132 | 106 | | foreach (var parameter in parameters) |
| | 43 | 107 | | parameter.OpenApiParameter.Extensions.TryAdd(ENTITY_DELETE_EXTENSION, new OpenApiBoolean(true)); |
| | 23 | 108 | | } |
| | | 109 | | |
| | | 110 | | private static void RemoveParametersMarkedForDeletion(OpenApiOperation operation) |
| | | 111 | | { |
| | 23 | 112 | | var parametersToRemove = operation.Parameters |
| | 23 | 113 | | .Where(parameter => parameter.Extensions.ContainsKey(ENTITY_DELETE_EXTENSION)) |
| | 23 | 114 | | .ToList(); |
| | | 115 | | |
| | 132 | 116 | | foreach (var parameter in parametersToRemove) |
| | 43 | 117 | | operation.Parameters.Remove(parameter); |
| | 23 | 118 | | } |
| | | 119 | | |
| | | 120 | | private static string GetPageNumberParameterName(ParameterDescriptor parameterDescriptor) |
| | | 121 | | { |
| | 43 | 122 | | var actionParameterName = parameterDescriptor.Name; |
| | 43 | 123 | | var bindingParameterName = parameterDescriptor.BindingInfo?.BinderModelName; |
| | 43 | 124 | | var (pageNumberName, _) = ParameterExtensions.GetPageParameterNames(actionParameterName, bindingParameterName); |
| | 43 | 125 | | return pageNumberName; |
| | | 126 | | } |
| | | 127 | | |
| | | 128 | | private static string GetPageSizeParameterName(ParameterDescriptor parameterDescriptor) |
| | | 129 | | { |
| | 43 | 130 | | var actionParameterName = parameterDescriptor.Name; |
| | 43 | 131 | | var bindingParameterName = parameterDescriptor.BindingInfo?.BinderModelName; |
| | 43 | 132 | | var (_, pageSizeName) = ParameterExtensions.GetPageParameterNames(actionParameterName, bindingParameterName); |
| | 43 | 133 | | return pageSizeName; |
| | | 134 | | } |
| | | 135 | | } |