SlickDevTools.AspNetCore.Converters.JsonToXml 3.0.1

SlickDevTools.AspNetCore.Converters.JsonToXml

A high-performance library for converting JSON data to XML format in C#. Version 3.0 includes critical bug fixes and performance improvements.

What's New in Version 3.0

• Fixed: Primitive array handling - now correctly converts arrays like [1, 2, 3] and ["a", "b", "c"]
• Improved: Array support for mixed content (objects and primitives)
• Enhanced: XML documentation for better IntelliSense support

Features

• Easy-to-use JSON to XML conversion
• Supports primitive arrays, object arrays, and mixed arrays
• Customization through JsonToXmlConverterOptions
• Handles nested objects and complex JSON structures
• Returns conversion result in JsonToXmlConverterResult object

Usage

Basic instantiation and conversion

1. Instantiate JsonToXmlConverterService class:

JsonToXmlConverterService converterService = new JsonToXmlConverterService();

2. Convert JSON to XML:

string json = "{ \"key\": \"value\" }";
JsonToXmlConverterResult result = converterService.Convert(json);

3. Access the converted XML string:

string xml = result.Xml;

Alternate instantiation and conversion with options

1. Instantiate JsonToXmlConverterService class with options:

// json string for a product
string json = @"{
    ""id"": 1,
    ""name"": ""Product 1"",
    ""price"": 100
}";
        
// create an instance of the json to xml serializer with options that sets the root element name to "product"
var service = new JsonToXmlConverterService(new JsonToXmlConverterOptions { RootElementName = "product" });

2. Convert JSON to XML:

var result = service.Convert(json);

3. Access the converted XML string:

// output the xml
var xmlString = result.Xml;

Classes

JsonToXmlConverterService

The main class that handles JSON to XML conversion. The constructor takes an optional JsonToXmlConverterOptions parameter to customize the conversion process. It has one public method, Convert, which takes a JSON string as input and returns a JsonToXmlConverterResult object containing the XML string.

JsonToXmlConverterOptions

A class that allows customization of the JSON to XML conversion process. Available options:

• RootElementName: Specify the name of the root XML element (default: "root")

JsonToXmlConverterResult

A class that holds the result of the JSON to XML conversion. It has one property, Xml, which contains the converted XML string.

Dependencies

• This library relies on the JsonToXmlConverter class to perform the actual JSON to XML conversion. Ensure that this class is included in your project.

Installation

dotnet add package SlickDevTools.AspNetCore.Converters.JsonToXml --version 3.0.0

Or via Package Manager Console:

Install-Package SlickDevTools.AspNetCore.Converters.JsonToXml -Version 3.0.0

Array Handling

Version 3.0 correctly handles all array types:

Primitive Arrays:

{ "numbers": [1, 2, 3] }

Converts to:

<root>
  <numbers>
    <item>1</item>
    <item>2</item>
    <item>3</item>
  </numbers>
</root>

Object Arrays (as before):

{ "items": [{"id": 1}, {"id": 2}] }

Mixed Arrays:

{ "mixed": [1, {"id": 2}, "text"] }

Supports: .NET 8.0

License

This project is released under the MIT License.