update: Add message template for `AppendActionCountToTagSummaryDocume…

…ntFilter`
unchase · Aug 26, 2021 · 60c27bf · 60c27bf
1 parent 2af9003
commit 60c27bf
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@
 
 These are the changes to each version that has been released on the [nuget](https://www.nuget.org/packages/Unchase.Swashbuckle.AspNetCore.Extensions/).
 
+## v2.6.7 `2021-08-26`
+
+- [x] Add message template for `AppendActionCountToTagSummaryDocumentFilter`
+
 ## v2.6.6 `2021-08-26`
 
 - [x] Add `IncludeXmlCommentsWithRemarks` improvements

diff --git a/README.md b/README.md
@@ -249,9 +249,9 @@ public void ConfigureServices(IServiceCollection services)
         // enable openApi Annotations
         options.EnableAnnotations();
 
-        // add action count into the SwaggerTag's descriptions
+        // add action count (with message template) into the SwaggerTag's descriptions
         // you can use it after "HidePathsAndDefinitionsByRolesDocumentFilter"
-        options.DocumentFilter<AppendActionCountToTagSummaryDocumentFilter>();
+        options.DocumentFilter<AppendActionCountToTagSummaryDocumentFilter>("(count: {0})");
 
         ...
     });

diff --git a/....Swashbuckle.AspNetCore.Extensions/Filters/AppendActionCountToTagSummaryDocumentFilter.cs b/....Swashbuckle.AspNetCore.Extensions/Filters/AppendActionCountToTagSummaryDocumentFilter.cs
@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Linq;
 using Microsoft.OpenApi.Models;
 using Swashbuckle.AspNetCore.SwaggerGen;
@@ -10,6 +11,24 @@ namespace Unchase.Swashbuckle.AspNetCore.Extensions.Filters
     /// </summary>
     public class AppendActionCountToTagSummaryDocumentFilter : IDocumentFilter
     {
+        private readonly string _messageTemplate;
+
+        #region Constructor
+
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        public AppendActionCountToTagSummaryDocumentFilter(string messageTemplate = "(action count: {0})")
+        {
+            _messageTemplate = messageTemplate;
+            if (!_messageTemplate.Contains("{0}"))
+            {
+                throw new ArgumentException("The message template must contains '{0}'.", nameof(messageTemplate));
+            }
+        }
+
+        #endregion
+
         #region Methods
 
         /// <summary>
@@ -43,7 +62,9 @@ public void Apply(OpenApiDocument openApiDoc, DocumentFilterContext context)
                 foreach (var tag in openApiDoc.Tags)
                 {
                     if (tag.Name == tagActionCountKey)
-                        tag.Description += $" (action count: {tagActionCount[tagActionCountKey]})";
+                    {
+                        tag.Description += string.Format($" {_messageTemplate}", tagActionCount[tagActionCountKey]);
+                    }
                 }
             }
         }

diff --git a/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj b/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj
@@ -14,9 +14,9 @@
     <NeutralLanguage></NeutralLanguage>
     <LangVersion>7.3</LangVersion>
     <PackageIconUrl>https://github.com/unchase/Unchase.Swashbuckle.AspNetCore.Extensions/blob/master/assets/icon.png?raw=true</PackageIconUrl>
-    <Version>2.6.6</Version>
-    <AssemblyVersion>2.6.6.0</AssemblyVersion>
-    <FileVersion>2.6.6.0</FileVersion>
+    <Version>2.6.7</Version>
+    <AssemblyVersion>2.6.7.0</AssemblyVersion>
+    <FileVersion>2.6.7.0</FileVersion>
     <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
     <DocumentationFile>Unchase.Swashbuckle.AspNetCore.Extensions.xml</DocumentationFile>
   </PropertyGroup>

diff --git a/src/Unchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.xml b/src/Unchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.xml
diff --git a/test/WebApi3.1-Swashbuckle/Startup.cs b/test/WebApi3.1-Swashbuckle/Startup.cs
@@ -96,9 +96,9 @@ public void ConfigureServices(IServiceCollection services)
                 // enable openApi Annotations
                 options.EnableAnnotations();
 
-                // add action count into the SwaggerTag's descriptions
+                // add action count (with message template) into the SwaggerTag's descriptions
                 // you can use it after "HidePathsAndDefinitionsByRolesDocumentFilter"
-                options.DocumentFilter<AppendActionCountToTagSummaryDocumentFilter>();
+                options.DocumentFilter<AppendActionCountToTagSummaryDocumentFilter>("(the count of actions: {0})");
 
                 #endregion