RicoSuter/NSwag

Generate a Rest Client with XML Deserialization and not JSON

Open

#2082 opened on Apr 3, 2019

View on GitHub
 (17 comments) (0 reactions) (0 assignees)C# (6,291 stars) (1,189 forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)type: enhancement

Description

I am interfacing with an "external web API server" that returns only xml content-type. I have generated a rest client with NswagStudio but an exception is always thrown because of the response type which is XML and the deserialisation type which is JSON.

Is there any way to generate a client with XML Deserialisation?

Contributor guide

Tech stack
csharptypescriptrest api
Domain
apitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C# basicsNSwag internalsXML serialization in .NET
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
The issue requests support for XML deserialization in NSwag generated clients. Investigate how NSwag currently generates deserialization code for JSON responses (likely using Newtonsoft.Json or System.Text.Json). Explore adding a similar path for XML using System.Xml.Serialization or XmlSerializer. The relevant source files likely include client generation templates (e.g., C# client template) and the code that configures serialization. Check existing documentation on customizing the client. This change requires modifying the generated code to accept XML based on content type. Consider adding a configuration option to switch between JSON and XML.