Greg

Swagger.Net.WebAPI/App_Start/SwaggerNet.cs

@@ -14,18 +14,17 @@ public static class SwaggerNet
     {
         public static void PreStart()
         {
-            RouteTable.Routes.MapHttpRoute(
-                name: "SwaggerResourceList",
-                routeTemplate: "apidocs/swagger",
-                defaults: new { swagger = true, controller = "Swagger", action = "GetResourceList" }
-            );
-            RouteTable.Routes.MapHttpRoute(
-                name: "SwaggerApiDeclaration",
-                routeTemplate: "apidocs/{controllerName}",
-                defaults: new { swagger = true, controller = "Swagger", action = "GetApiDeclaration" }
-            );
+            //RouteTable.Routes.MapHttpRoute(
+            //    name: "SwaggerResourceList",
+            //    routeTemplate: "api/swagger",
+            //    defaults: new { swagger = true, controller = "Swagger", action = "GetResourceList" }
+            //);
+            //RouteTable.Routes.MapHttpRoute(
+            //    name: "SwaggerApiDeclaration",
+            //    routeTemplate: "apidocs/{controllerName}",
+            //    defaults: new { swagger = true, controller = "Swagger", action = "GetApiDeclaration" }
+            //);
 
-            SwaggerConfiguration.DefaultConfiguration = SwaggerConfiguration.CreateDefaultConfig(GlobalConfiguration.Configuration);
         }
     }
 }

Swagger.Net.WebAPI/Controllers/BlogPostsController.cs

@@ -7,6 +7,12 @@
 
 namespace Swagger.Net.WebApi.Controllers
 {
+    /// <summary>
+    /// This is blog posts controller summary
+    /// </summary>
+    /// <remarks>
+    /// This is blog posts controller remarks
+    /// </remarks>
     public class BlogPostsController : ApiController
     {
         // GET api/blogposts

Swagger.Net.WebAPI/Global.asax.cs

@@ -1,8 +1,10 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Reflection;
 using System.Web;
 using System.Web.Http;
+using System.Web.Http.Description;
 using System.Web.Mvc;
 using System.Web.Optimization;
 using System.Web.Routing;
@@ -22,6 +24,11 @@ protected void Application_Start()
             FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
             RouteConfig.RegisterRoutes(RouteTable.Routes);
             BundleConfig.RegisterBundles(BundleTable.Bundles);
+
+            var baseType = HttpContext.Current.ApplicationInstance.GetType().BaseType;
+            var assemblyname = Assembly.GetAssembly(baseType).GetName().Name;
+            var path = HttpContext.Current.Server.MapPath("~/bin/" + assemblyname + ".xml");
+            GlobalConfiguration.Configuration.Services.Replace(typeof(IDocumentationProvider),new XmlCommentDocumentationProvider(path));
         }
     }
 }

Swagger.Net.WebAPI/Views/Home/Index.cshtml

@@ -1,4 +1,4 @@
 <h1>Welcome to ASP.NET Web API!</h1>
 Navigate to <a href="/docs">/docs</a> for the Swagger UI docs.  These are not included in the NuGet package.<br />
-Navigate to <a href="/apidocs/swagger">/api/swagger</a> to see the JSON specification emitted.<br />
+Navigate to <a href="/api/swagger">/api/swagger</a> to see the JSON specification emitted.<br />
 You may then navigate to each api path to see the JSON documentation for each ApiController individually.

Swagger.Net.WebAPI/Web.config

@@ -12,6 +12,7 @@
     <add name="DefaultConnection" providerName="System.Data.SqlClient" connectionString="Data Source=(LocalDb)\v11.0;Initial Catalog=aspnet-Swagger.Net.WebApi-20120826143632;Integrated Security=SSPI;AttachDBFilename=|DataDirectory|\aspnet-Swagger.Net.WebApi-20120826143632.mdf" />
   </connectionStrings>
   <appSettings>
+    <add key="document_controller_alias" value="api" />
     <add key="webpages:Version" value="2.0.0.0" />
     <add key="webpages:Enabled" value="false" />
     <add key="PreserveLoginUrl" value="true" />

Swagger.Net.WebAPI/docs/index.html

@@ -42,7 +42,7 @@
     <script type="text/javascript">
         $(function () {
             window.swaggerUi = new SwaggerUi({
-                discoveryUrl: "/apidocs/swagger",
+                discoveryUrl: "/api/swagger",
                 apiKey: "",
                 dom_id:"swagger-ui-container",
                 supportHeaderParams: false,

Swagger.Net/Swagger.Net.csproj

@@ -38,6 +38,7 @@
   <ItemGroup>
     <Reference Include="System" />
     <Reference Include="System.ComponentModel.DataAnnotations" />
+    <Reference Include="System.Configuration" />
     <Reference Include="System.Core" />
     <Reference Include="System.Data.Entity" />
     <Reference Include="System.Net.Http" />
@@ -53,6 +54,7 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
+    <Compile Include="Factories\ResourceListingFactory.cs" />
     <Compile Include="Models\Api.cs" />
     <Compile Include="Models\ApiDeclaration.cs" />
     <Compile Include="Models\ApiErrorResponse.cs" />

Swagger.Net/SwaggerConfiguration.cs

@@ -1,41 +1,60 @@
 using System;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Configuration;
+using System.Dynamic;
 using System.Linq;
 using System.Text;
 using System.Web;
 using System.Web.Http;
+using System.Web.Http.Description;
 
 namespace Swagger.Net
 {
+
     public class SwaggerConfiguration
     {
-        /// <summary>
-        /// Static instance used by default
-        /// </summary>
-        public static SwaggerConfiguration DefaultConfiguration { get; set; }
-
-        /// <summary>
-        /// The API version of your application
-        /// </summary>
-        public virtual string ApiVersion { get; set; }
+        private static SwaggerConfiguration _instance;
 
-        /// <summary>
-        /// Swagger-spec version
-        /// </summary>
+        private HttpContext _context;
+        private Collection<ApiDescription> _apiDescriptions;
+
+        public virtual string ApiVersion { get; set; }
         public virtual string SwaggerVersion { get; set; }
+        public virtual string DocumentControllerAlias { get; set; }
 
 
-        public virtual System.Web.Http.Description.IApiExplorer ApiExplorer { get; set; }
+        public Collection<ApiDescription> ApiDescriptions
+        {
+            get { return _apiDescriptions ?? GlobalConfiguration.Configuration.Services.GetApiExplorer().ApiDescriptions; }
+            set { _apiDescriptions = value; }
+        }
 
-        public static SwaggerConfiguration CreateDefaultConfig(HttpConfiguration httpConfig) {
+        public HttpContext HttpContext
+        {
+            get { return _context ?? HttpContext.Current; }
+            set { _context = value; }
+        }
+
+        // Singleton
+        public static SwaggerConfiguration Instance
+        {
+            get { return _instance ?? (_instance = CreateDefaultInstance()); }
+            set { _instance = value; }
+        }
+
+
+        public static SwaggerConfiguration CreateDefaultInstance()
+        {
+            // todo: fetch from web.config
+            var alias = ConfigurationManager.AppSettings["document_controller_alias"] ?? "api";
             return new SwaggerConfiguration()
             {
                 SwaggerVersion = "1.1",
-                ApiVersion = System.Reflection.Assembly.GetCallingAssembly().GetType().Assembly.GetName().Version.ToString(),
-                ApiExplorer = httpConfig.Services.GetApiExplorer()
+                ApiVersion = System.Reflection.Assembly.GetCallingAssembly().GetName().Version.ToString(),
+                DocumentControllerAlias = alias,
             };
         }
 
-
     }
 }

Swagger.Net/SwaggerController.cs

@@ -6,6 +6,7 @@
 using System.Web.Http;
 using System.Linq;
 using System.Text.RegularExpressions;
+using Swagger.Net.Factories;
 
 namespace Swagger.Net
 {
@@ -22,44 +23,35 @@ public class SwaggerController : ApiController
         /// <returns>JSON document representing structure of API</returns>
         public HttpResponseMessage GetResourceList()
         {
-            var config = SwaggerConfig ?? SwaggerConfiguration.DefaultConfiguration;
-            var httpContext = new HttpContextWrapper(HttpContext.Current);  // TODO: testable way to pass context
-
-            var resourceListing = new Models.ResourceListing()
-            {
-                apiVersion = config.ApiVersion,
-                basePath = ResolveServerUrl("~", httpContext),
-                swaggerVersion = config.SwaggerVersion,
-                apis = from d in config.ApiExplorer.ApiDescriptions
-                       where d.ActionDescriptor.ControllerDescriptor.ControllerType != this.GetType()
-                       group d by d.ActionDescriptor.ControllerDescriptor.ControllerName into g
-                       select new Models.ResourceListing.ResourceListingApi()
-                       {
-                           path = "/apidocs/" + g.Key 
-                       }
-            };
+            // Arrange
+            var config = SwaggerConfig ?? SwaggerConfiguration.Instance;
+            var factory = new ResourceListingFactory();
+
+            // Act
+            var resourceListing = factory.Create(config);
 
+            // Answer
             return new HttpResponseMessage()
             {
                 Content = new ObjectContent<Models.ResourceListing>(resourceListing, ControllerContext.Configuration.Formatters.JsonFormatter)
             };
         }
 
         /// <summary>
-	/// Get the API Declaration for a particular controller
-	/// </summary>
-        public Models.ApiDeclaration GetApiDeclaration(string controllerName)
+        /// Get the API Declaration for a particular controller
+        /// </summary>
+        public Models.ApiDeclaration GetApiDeclaration(string id)
         {
-            var config = SwaggerConfig ?? SwaggerConfiguration.DefaultConfiguration;
+            var config = SwaggerConfig ?? SwaggerConfiguration.Instance;
             var httpContext = new HttpContextWrapper(HttpContext.Current);  // TODO: testable way to pass context
 
             return new Models.ApiDeclaration()
             {
                 apiVersion = config.ApiVersion,
                 swaggerVersion = config.SwaggerVersion,
                 basePath = ResolveServerUrl("~", httpContext),
-                apis = from d in config.ApiExplorer.ApiDescriptions
-                       where d.ActionDescriptor.ControllerDescriptor.ControllerName == controllerName
+                apis = from d in config.ApiDescriptions
+                       where d.ActionDescriptor.ControllerDescriptor.ControllerName == id
                        group d by d.RelativePath into paths
                        select new Models.Api()
                        {
@@ -76,8 +68,8 @@ group d by d.RelativePath into paths
         }
 
         private static string ResolveServerUrl(string relativeUrl, HttpContextWrapper httpContext)
-	    {
+        {
             return httpContext.Request.Url.GetLeftPart(UriPartial.Authority) + VirtualPathUtility.ToAbsolute(relativeUrl);
-	    }
+        }
     }
 }