Nswag: Epic: Support System.Text.Json

[RicoSuter]

A: Use System.Text.Json in generated C# models (DTOs):

• NJsonSchema
  
  
  
  • https://github.com/RicoSuter/NJsonSchema/issues/1013
  
  
• NSwag
  
  
  
  • Use System.Text.Json serializer in ReadObjectResponseAsync (client generator)
  
  

B: Use System.Text.Json in JSON Schema generator (also used to generate OpenAPI model schemas):

• NJsonSchema
  
  
  
  • https://github.com/RicoSuter/NJsonSchema/issues/1014
  
  

Out of scope:

• Use System.Text.Json to serialize schemas, documents, etc.

Tasks:

• [ ] Document new property SerializerOptions

[JoFrMueller]

We're currently moving internal libraries towards System.Text.Json and wonder what the plans for NSwag are regarding migration?

Dazinator makes 2316 sound like you would loose interoperability by not being able to use data contracts anymore. Could you perhaps comment on this and your planned schedule regarding System.Text.Json? Thanks a lot!

[RicoSuter]

Do you need A or B?

[JoFrMueller]

We don't care about data contracts currently. So:

• A: System.Text.Json <-- Waiting impatiently.
• B: DataContract <-- More interesting from an academic/wider point of view...

[skorunka]

Hello, how does it look with A?

[RicoSuter]

No work done yet, but A is the one which is feasible to implement already. B is not possible because no metadata is exposed.

[8VAid8]

@RicoSuter Do you have any progress with A? I've checked a client behavior with replaced Newtonsoft by System.Text.Json. It works.

[stefanluchian]

I can hardly wait to use the asynchronous deserialization (DeserializeAsync) from System.Text.Json.
It would be very handy to be able to choose between Newtonsoft and System.Text.Json for the generation of C# client.

[Jacko1394]

I'd also love to see optional support for System.Text.Json :D

[dubtar]

While this is in progress, is there a workaround to serialize enums as string? In my .net core 3.1 project with nswag.aspnetcore 13.4.2 it does not recognize services.AddJsonOptions(c=>c.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()))) and adding services.AddOpenApiDocument(c => c.DefaultEnumHandling = NJsonSchema.Generation.EnumHandling.String); break data class fields casing: id becomes Id.

[jnovick]

Any update on this?

[8VAid8]

I didn't want to wait and just made a simple Newtonsoft -> System.Text.Json converter (it has planty bugs, i guess, but works for me) for my Blazor project. @Jacko1394 you can try this way while the feature implementation is in progress.

[RicoSuter]

@8VAid8 Thanks for sharing your solution - we should support that out-of-the-box as a "generator template style", this is tracked mainly here:

https://github.com/RicoSuter/NJsonSchema/issues/1013

[RicoSuter]

@dubtar @jnovick System.Text.Json support in the schema generator has been greatly improved, see https://github.com/RicoSuter/NJsonSchema/issues/1014 (NSwag v13.5.0)

[dubtar]

Yep, thanks a ton! 13.5.0 resolved my issues - now typescript clients work for me with enums as string.

[electricessence]

You could simply inject the serializer agnostically:
https://www.nuget.org/packages/Open.Serialization.Json/

[SommerEngineering]

Thanks alot @RicoSuter 🙂 It works now out-of-the-box within my blazor wasm client.