Merge pull request #307 from domaindrivendev/improve-swagger-serializ…

…ation Use app serialization for 'example' and 'default' fields
domaindrivendev · Feb 27, 2017 · 328bcd7 · 328bcd7
2 parents cfdf86a + 3184c6f
commit 328bcd7
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 19 deletions.
diff --git a/src/Swashbuckle.AspNetCore.Swagger/Application/SwaggerContractResolver.cs b/src/Swashbuckle.AspNetCore.Swagger/Application/SwaggerContractResolver.cs
@@ -1,26 +1,50 @@
 using System;
+using System.Reflection;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Serialization;
 
 namespace Swashbuckle.AspNetCore.Swagger
 {
     public class SwaggerContractResolver : DefaultContractResolver
     {
-        private readonly JsonSerializer _appJsonSerializer;
-        private readonly CamelCasePropertyNamesContractResolver _camelCasePropertyNamesContractResolver;
+        private readonly JsonConverter _applicationTypeConverter;
 
-        public SwaggerContractResolver(JsonSerializerSettings appSerializerSettings)
+        public SwaggerContractResolver(JsonSerializerSettings applicationSerializerSettings)
         {
-            _appJsonSerializer = JsonSerializer.Create(appSerializerSettings);
-            _camelCasePropertyNamesContractResolver = new CamelCasePropertyNamesContractResolver();
+            NamingStrategy = new CamelCaseNamingStrategy { ProcessDictionaryKeys = false };
+            _applicationTypeConverter = new ApplicationTypeConverter(applicationSerializerSettings);
         }
 
-        public override JsonContract ResolveContract(Type type)
+        protected override JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)
         {
-            var defaultContract = base.ResolveContract(type);
-            if (defaultContract is JsonDictionaryContract) return defaultContract;
+            var jsonProperty = base.CreateProperty(member, memberSerialization);
 
-            return _camelCasePropertyNamesContractResolver.ResolveContract(type);
+            if (member.Name == "Example" || member.Name == "Examples" || member.Name == "Default")
+                jsonProperty.Converter = _applicationTypeConverter;
+
+            return jsonProperty;
+        }
+
+        private class ApplicationTypeConverter : JsonConverter
+        {
+            private JsonSerializer _applicationTypeSerializer;
+
+            public ApplicationTypeConverter(JsonSerializerSettings applicationSerializerSettings)
+            {
+                _applicationTypeSerializer = JsonSerializer.Create(applicationSerializerSettings);
+            }
+
+            public override bool CanConvert(Type objectType) { return true; }
+
+            public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
+            {
+                throw new NotImplementedException();
+            }
+
+            public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
+            {
+                _applicationTypeSerializer.Serialize(writer, value);
+            }
         }
     }
 }
diff --git a/src/Swashbuckle.AspNetCore.Swagger/Application/SwaggerSerializerFactory.cs b/src/Swashbuckle.AspNetCore.Swagger/Application/SwaggerSerializerFactory.cs
@@ -6,14 +6,14 @@ namespace Swashbuckle.AspNetCore.Swagger
 {
     public class SwaggerSerializerFactory
     {
-        internal static JsonSerializer Create(IOptions<MvcJsonOptions> mvcJsonOptions)
+        internal static JsonSerializer Create(IOptions<MvcJsonOptions> applicationJsonOptions)
         {
             // TODO: Should this handle case where mvcJsonOptions.Value == null?
             return new JsonSerializer
             {
                 NullValueHandling = NullValueHandling.Ignore,
-                Formatting = mvcJsonOptions.Value.SerializerSettings.Formatting,
-                ContractResolver = new SwaggerContractResolver(mvcJsonOptions.Value.SerializerSettings)
+                Formatting = applicationJsonOptions.Value.SerializerSettings.Formatting,
+                ContractResolver = new SwaggerContractResolver(applicationJsonOptions.Value.SerializerSettings)
             };
         }
     }

diff --git a/test/WebSites/Basic/Controllers/SwaggerAnnotationsController.cs b/test/WebSites/Basic/Controllers/SwaggerAnnotationsController.cs
@@ -7,6 +7,7 @@ namespace Basic.Controllers
     public class SwaggerAnnotationsController
     {
         [SwaggerOperation("CreateCart")]
+        [SwaggerOperationFilter(typeof(AddCreateCartResponseExamples))]
         [HttpPost("/carts")]
         public Cart Create([FromBody]Cart cart)
         {

diff --git a/test/WebSites/Basic/Startup.cs b/test/WebSites/Basic/Startup.cs
@@ -27,7 +27,7 @@ public void ConfigureServices(IServiceCollection services)
                 .AddMvc()
                 .AddJsonOptions(options =>
                 {
-                    options.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();
+                    options.SerializerSettings.ContractResolver = new DefaultContractResolver();
                 });
 
             // Uncomment the following line to add Web API services which makes it easier to port Web API 2 controllers.

diff --git a/test/WebSites/Basic/Swagger/AddCartDefault.cs b/test/WebSites/Basic/Swagger/AddCartDefault.cs
@@ -1,6 +1,7 @@
 using Microsoft.Extensions.Logging;
 using Swashbuckle.AspNetCore.Swagger;
 using Swashbuckle.AspNetCore.SwaggerGen;
+using Basic.Controllers;
 
 namespace Basic.Swagger
 {
@@ -17,9 +18,9 @@ public void Apply(Schema schema, SchemaFilterContext context)
         {
             _logger.LogInformation("Applying an awesome Schema Filter that leverages Dependency Injection");
 
-            schema.Default = new
+            schema.Default = new Cart
             {
-                Id = 123
+                Id = 123,
             };
         }
     }

diff --git a/test/WebSites/Basic/Swagger/AddCreateCartResponseExamples.cs b/test/WebSites/Basic/Swagger/AddCreateCartResponseExamples.cs
@@ -0,0 +1,18 @@
+using System.Collections.Generic;
+using Swashbuckle.AspNetCore.SwaggerGen;
+using Swashbuckle.AspNetCore.Swagger;
+using Basic.Controllers;
+
+namespace Basic.Swagger
+{
+    public class AddCreateCartResponseExamples : IOperationFilter
+    {
+        public void Apply(Operation operation, OperationFilterContext context)
+        {
+            operation.Responses["200"].Examples = new Dictionary<string, Cart>
+            {
+                { "application/json", new Cart { Id = 333 } }
+            };
+        }
+    }
+}
diff --git a/test/WebSites/Basic/project.json b/test/WebSites/Basic/project.json
@@ -12,6 +12,7 @@
     "Microsoft.AspNetCore.Diagnostics": "1.0.0",
     "Microsoft.Extensions.Logging.Console": "1.0.0",
     "Microsoft.Extensions.Logging.Debug": "1.0.0",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },

diff --git a/test/WebSites/CustomIndexHtml/project.json b/test/WebSites/CustomIndexHtml/project.json
@@ -1,4 +1,4 @@
-{
+{
   "buildOptions": {
     "emitEntryPoint": true,
     "preserveCompilationContext": true
@@ -10,6 +10,7 @@
     "Microsoft.AspNetCore.Diagnostics": "1.0.0",
     "Microsoft.Extensions.Logging.Console": "1.0.0",
     "Microsoft.Extensions.Logging.Debug": "1.0.0",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },

diff --git a/test/WebSites/CustomUIConfig/project.json b/test/WebSites/CustomUIConfig/project.json
@@ -1,4 +1,4 @@
-{
+{
   "buildOptions": {
     "emitEntryPoint": true,
     "preserveCompilationContext": true
@@ -10,6 +10,7 @@
     "Microsoft.AspNetCore.Diagnostics": "1.0.0",
     "Microsoft.Extensions.Logging.Console": "1.0.0",
     "Microsoft.Extensions.Logging.Debug": "1.0.0",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },

diff --git a/test/WebSites/GenericControllers/project.json b/test/WebSites/GenericControllers/project.json
@@ -1,4 +1,4 @@
-{
+{
   "buildOptions": {
     "emitEntryPoint": true,
     "preserveCompilationContext": true
@@ -10,6 +10,7 @@
     "Microsoft.AspNetCore.Diagnostics": "1.0.0",
     "Microsoft.Extensions.Logging.Console": "1.0.0",
     "Microsoft.Extensions.Logging.Debug": "1.0.0",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },

diff --git a/test/WebSites/MultipleVersions/project.json b/test/WebSites/MultipleVersions/project.json
@@ -1,4 +1,4 @@
-{
+{
   "buildOptions": {
     "emitEntryPoint": true,
     "preserveCompilationContext": true
@@ -11,6 +11,7 @@
     "Microsoft.AspNetCore.Diagnostics": "1.0.0",
     "Microsoft.Extensions.Logging.Console": "1.0.0",
     "Microsoft.Extensions.Logging.Debug": "1.0.0",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },

diff --git a/test/WebSites/OAuth2Integration/project.json b/test/WebSites/OAuth2Integration/project.json
@@ -17,6 +17,7 @@
     "Microsoft.Extensions.Configuration.Json": "1.0.0",
     "IdentityServer4": "1.0.0-rc4-update1",
     "IdentityServer4.AccessTokenValidation": "1.0.1-rc4-update1",
+    "Swashbuckle.AspNetCore.Swagger": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerGen": "1.0.0-*",
     "Swashbuckle.AspNetCore.SwaggerUI": "1.0.0-*"
   },