2020/06/27/exposing-custom-type-as-json-string-in-asp-net-core-api/

[utterances-bot]

Exposing a custom type as a JSON string in an ASP.NET Core API - Thomas Levesque's .NET Blog

https://thomaslevesque.com/2020/06/27/exposing-custom-type-as-json-string-in-asp-net-core-api/

[AroglDarthu]

Hi Thomas,

Thanks for the clear explanation.
The call to options.MapType only seems to work for responses though. Is there a way to also get the equivalent swagger description for parameters?
There's a stackoverflow question on this here, unfortunately without any answers:
https://stackoverflow.com/questions/52068622/swashbuckle-maptypetype-doesnt-work-with-parameters

Thanks,
Twan

[AroglDarthu]

I'm guessing I need a TypeConverter...

[thomaslevesque]

Hi @AroglDarthu,

It works fine for me, parameters are correctly represented as string in swagger.
You do need a type converter for model binding to work, though.

[AroglDarthu]

I found that if used on the query string, then both the model binder and swagger show a custom struct as if it were a complex type: ?date.year=0&date.month=0&date.day=0.

A corresponding IModelBinder can solve this for the api, but does not work for Swagger.
I would have thought that the options.MapType would be enough for Swashbuckle to correctly define the scheme in Swagger. Unfortunately for query string parameters it works a bit differently.

Adding a TypeConverter helps for both.

See also: dotnet/aspnetcore#4825