Arrange operations alphabetically in Swashbuckle Swagger.

Swashbuckle normally lists operations on it's Swagger documentation page in the order that the operations appear on the controller. This filter allows for the operations to be listed alphabetically. Update swashbuckle-swagger-operation-alphabetical-order.md Update and rename swashbuckle-swagger-operation-alphabetical-order.md to Swashbuckle-Swagger-Operation-Alphabetical-Order.md Closes #508
FreeCodeCamp · fc96f70ba9014c98939abdb9f5cd422d2446d2e8 · pallu committed with Rafase282 Mar 4, 2016 · Mar 4, 2016 · fc96f70
1 parent 643b324
commit fc96f70ba9014c98939abdb9f5cd422d2446d2e8
Unified Split

Showing with 73 additions and 0 deletions.

+73 −0 Swashbuckle-Swagger-Operation-Alphabetical-Order.md
@@ -0,0 +1,73 @@
+# Arranging operations alphabetically in Swashbuckle Swagger
+
+[Swashbuckle](https://github.com/domaindrivendev/Swashbuckle) seamlessly adds a [Swagger](http://swagger.io/) to WebAPI projects. However, the operations on the page do not appear in alphabetical order. However, Swashbuckle allows custom filters and with a little code, this is easy enough to implement. The code below creates a [DocumentFilter](https://github.com/domaindrivendev/Swashbuckle#documentfilter) which is then applied to the final document as outlined [here](https://github.com/domaindrivendev/Swashbuckle#modifying-generated-operations).
+
+The Gist is available [here](https://gist.github.com/pallu/0f28e98fa89d2855a321).
+
+And here's the same code
+
+```C#
+using Swashbuckle.Swagger;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Web;
+
+namespace YourNamespace.Swagger.Extensions
+{
+    public class CustomDocumentFilter : IDocumentFilter
+    {
+        public void Apply(SwaggerDocument swaggerDoc, SchemaRegistry schemaRegistry, System.Web.Http.Description.IApiExplorer apiExplorer)
+        {
+            //make operations alphabetic
+            var paths = swaggerDoc.paths.OrderBy(e => e.Key).ToList();
+            swaggerDoc.paths = paths.ToDictionary(e => e.Key, e => e.Value);
+
+            //controller comments do not get added to swagger docs. This is how to add them.
+            AddControllerDescriptions(swaggerDoc, apiExplorer);
+            
+        }
+
+        private static void AddControllerDescriptions(SwaggerDocument swaggerDoc, System.Web.Http.Description.IApiExplorer apiExplorer)
+        {
+            var doc = new YourPortal.Areas.HelpPage.XmlDocumentationProvider(GetXmlCommentsPath());
+
+            List<Tag> lst = new List<Tag>();
+            var desc = apiExplorer.ApiDescriptions;
+            ILookup<HttpControllerDescriptor, ApiDescription> apiGroups = desc.ToLookup(api => api.ActionDescriptor.ControllerDescriptor);
+            foreach (var apiGroup in apiGroups)
+            {
+                string tagName = apiGroup.Key.ControllerName;
+                var tag = new Tag { name = tagName };
+                var apiDoc = doc.GetDocumentation(apiGroup.Key);
+                if (!String.IsNullOrWhiteSpace(apiDoc))
+                    tag.description = apiDoc;
+                lst.Add(tag);
+
+            }
+            if (lst.Count() > 0)
+                swaggerDoc.tags = lst.ToList();
+        }
+        private static string GetXmlCommentsPath()
+        {
+            return System.Web.Hosting.HostingEnvironment.MapPath("~/App_Data/YourPortal.xml");
+        }
+    }
+}
+```
+Now you can simply add it to the config file like this
+```csharp
+.EnableSwagger(c =>
+	{
+    	...
+    	c.DocumentFilter<YourNamespace.Swagger.Extensions.CustomDocumentFilter>();
+        ...
+    }
+);
+```
+### References:
+
+ * [Swashbuckle](https://github.com/domaindrivendev/Swashbuckle)
+ * [Swagger](http://swagger.io/)
+ * [DocumentFilter](https://github.com/domaindrivendev/Swashbuckle#documentfilter)
+ * [Gist for code above](https://gist.github.com/pallu/0f28e98fa89d2855a321)