-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #307 from domaindrivendev/improve-swagger-serializ…
…ation Use app serialization for 'example' and 'default' fields
- Loading branch information
Showing
12 changed files
with
69 additions
and
19 deletions.
There are no files selected for viewing
42 changes: 33 additions & 9 deletions
42
src/Swashbuckle.AspNetCore.Swagger/Application/SwaggerContractResolver.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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); | ||
} | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
18 changes: 18 additions & 0 deletions
18
test/WebSites/Basic/Swagger/AddCreateCartResponseExamples.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 } } | ||
}; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters