WebApiContrib.Core.Formatter.Csv
4.0.0
dotnet add package WebApiContrib.Core.Formatter.Csv --version 4.0.0
NuGet\Install-Package WebApiContrib.Core.Formatter.Csv -Version 4.0.0
<PackageReference Include="WebApiContrib.Core.Formatter.Csv" Version="4.0.0" />
paket add WebApiContrib.Core.Formatter.Csv --version 4.0.0
#r "nuget: WebApiContrib.Core.Formatter.Csv, 4.0.0"
// Install WebApiContrib.Core.Formatter.Csv as a Cake Addin
#addin nuget:?package=WebApiContrib.Core.Formatter.Csv&version=4.0.0
// Install WebApiContrib.Core.Formatter.Csv as a Cake Tool
#tool nuget:?package=WebApiContrib.Core.Formatter.Csv&version=4.0.0
Import and Export CSV in ASP.NET Core
WebApiContrib.Core.Formatter.Csv
History
- 2021.02.11: Enclosed quotes expansion
- 2020.07.17: Add Support for Header Translation
- 2020.04.16: Improved compliance to RFC4180
- 2020.04.06: Replace smart quotes when encoding is Windows-1252
- 2018.11.23: Encoding bug fix, configuration change, ReadLine input changed to ReadLineAsync and protected
- 2018.10.24: Support IEnumerable instead of ILIst for the OutputFormatter, OrderBy and format fix
- 2018.09.14: Added correct usage of CanRead/CanReadType
- 2018.05.31: Adding support for ignoring propeties in the CSV DTO
- 2018.04.18: Adding support for customization of the header with the display attribute
- 2018.04.12: Using the encoding from the options in the CsvOutputFormatter, Don't buffer CSV
- 2017.02.14: update to csproj
- 2016.06.22: project init
Documentation
The InputFormatter and the OutputFormatter classes are used to convert the csv data to the C# model classes.
Code sample: https://github.com/WebApiContrib/WebAPIContrib.Core/tree/master/samples/WebApiContrib.Core.Samples
The LocalizationRecord class is used as the model class to import and export to and from csv data.
You can customize header with the DisplayAttribute.
using System.ComponentModel.DataAnnotations;
namespace WebApiContrib.Core.Samples.Model
{
public class LocalizationRecord
{
[JsonIgnore]
public long? Id { get; set; }
[JsonProperty(PropertyName = "CustomKeyName")]
public string Key { get; set; }
public string Text { get; set; }
public string LocalizationCulture { get; set; }
public string ResourceKey { get; set; }
}
}
The MVC Controller CsvTestController makes it possible to import and export the data. The Get method exports the data using the Accept header in the HTTP Request. Per default, Json will be returned. If the Accept Header is set to 'text/csv', the data will be returned as csv. The GetDataAsCsv method always returns csv data because the Produces attribute is used to force this. This makes it easy to download the csv data in a browser.
The Import method uses the Content-Type HTTP Request header to decide how to handle the request body. If the 'text/csv' is defined, the custom csv input formatter will be used.
using System.Collections.Generic;
using Microsoft.AspNetCore.Mvc;
using WebApiContrib.Core.Samples.Model;
namespace WebApiContrib.Core.Samples.Controllers
{
[Route("api/[controller]")]
public class CsvTestController : Controller
{
// GET api/csvtest
[HttpGet]
public IActionResult Get()
{
return Ok(DummyDataList());
}
[HttpGet]
[Route("data.csv")]
[Produces("text/csv")]
public IActionResult GetDataAsCsv()
{
return Ok( DummyDataList());
}
private static IEnumerable<LocalizationRecord> DummyDataList()
{
var model = new List<LocalizationRecord>
{
new LocalizationRecord
{
Id = 1,
Key = "test",
Text = "test text",
LocalizationCulture = "en-US",
ResourceKey = "test",
ResourceValue = "test value"
},
new LocalizationRecord
{
Id = 2,
Key = "test",
Text = "test2 text de-CH",
LocalizationCulture = "de-CH",
ResourceKey = "test",
ResourceValue = "test value"
}
};
return model;
}
// POST api/csvtest/import
[HttpPost]
[Route("import")]
public IActionResult Import([FromBody]List<LocalizationRecord> value)
{
if (!ModelState.IsValid)
{
return BadRequest(ModelState);
}
else
{
List<LocalizationRecord> data = value;
return Ok();
}
}
}
}
The formatters can be added to the ASP.NET Core project in the Startup class in the ConfigureServices method. The code configuration accepts an options object to define the delimiter and if a single line header should be included in the csv file or not.
The default delimiter is set to ';' and the header is included by default.
Optionally setting IncludeExcelDelimiterHeader to true adds the "sep=," header, so the files can be opened in Excel directly and setting ReplaceLineBreakCharacters to false preserves line break characters by enclosing text with quotes.
public void ConfigureServices(IServiceCollection services)
{
//var csvOptions = new CsvFormatterOptions
//{
// UseSingleLineHeaderInCsv = true,
// CsvDelimiter = ",",
// IncludeExcelDelimiterHeader = true
//};
// .AddCsvSerializerFormatters(new CsvFormatterOptions() { Encoding = Encoding.UTF8 })
//services.AddMvc()
// .AddCsvSerializerFormatters(csvOptions);
services.AddMvc()
.AddCsvSerializerFormatters();
}
The custom formatters can also be configured directly. The Content-Type 'text/csv' is used for the csv formatters.
public void ConfigureServices(IServiceCollection services)
{
var csvFormatterOptions = new CsvFormatterOptions();
services.AddMvc(options =>
{
options.InputFormatters.Add(new CsvInputFormatter(csvFormatterOptions));
options.OutputFormatters.Add(new CsvOutputFormatter(csvFormatterOptions));
options.FormatterMappings.SetMediaTypeMappingForFormat("csv", MediaTypeHeaderValue.Parse("text/csv"));
});
}
When the data.csv link is requested, a csv type response is returned to the client, which can be saved. This data contains the header texts and the value of each property in each object. This can then be opened in excel.
http://localhost:10336/api/csvtest/data.csv
Id;Key;Text;LocalizationCulture;ResourceKey
1;test;test text;en-US;test
2;test;test2 text de-CH;de-CH;test
This data can then be used to upload the csv data to the server which is then converted back to a C# object. I use fiddler, postman or curl can also be used, or any HTTP Client where you can set the header Content-Type.
http://localhost:10336/api/csvtest/import
User-Agent: Fiddler
Content-Type: text/csv
Host: localhost:10336
Content-Length: 110
Id;Key;Text;LocalizationCulture;ResourceKey
1;test;test text;en-US;test
2;test;test2 text de-CH;de-CH;test
Notes
The implementation of the InputFormatter and the OutputFormatter classes are specific for a list of simple classes with only properties. If you require or use more complex classes, these implementations need to be changed.
Links
https://damienbod.com/2015/06/03/asp-net-5-mvc-6-custom-protobuf-formatters/
http://www.strathweb.com/2014/11/formatters-asp-net-mvc-6/
https://wildermuth.com/2016/03/16/Content_Negotiation_in_ASP_NET_Core
Product | Versions |
---|---|
.NET | net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows |
.NET Core | netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1 |
.NET Standard | netstandard2.0 netstandard2.1 |
.NET Framework | net461 net462 net463 net47 net471 net472 net48 net481 |
MonoAndroid | monoandroid |
MonoMac | monomac |
MonoTouch | monotouch |
Tizen | tizen40 tizen60 |
Xamarin.iOS | xamarinios |
Xamarin.Mac | xamarinmac |
Xamarin.TVOS | xamarintvos |
Xamarin.WatchOS | xamarinwatchos |
-
.NETStandard 2.0
- Microsoft.AspNetCore.Mvc.Core (>= 2.1.3)
- System.ComponentModel.Annotations (>= 4.5.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories (3)
Showing the top 3 popular GitHub repositories that depend on WebApiContrib.Core.Formatter.Csv:
Repository | Stars |
---|---|
csharpfritz/csharp_with_csharpfritz
Show notes, slides, and samples from the CSharp with CSharpFritz show
|
|
mattfrear/Swashbuckle.AspNetCore.Filters
A bunch of useful filters for Swashbuckle.AspNetCore
|
|
damienbod/AspNetCoreLocalization
Localization.SqlLocalizer & ASP.NET Core MVC Localization Examples
|
Version | Downloads | Last updated |
---|---|---|
4.0.0 | 276,992 | 2/11/2021 |
3.0.2 | 49,812 | 7/17/2020 |
3.0.1 | 92,880 | 4/6/2020 |
3.0.0 | 179,798 | 11/24/2018 |
2.1.0 | 6,076 | 11/23/2018 |
2.0.7 | 5,440 | 10/24/2018 |
2.0.6 | 4,366 | 9/14/2018 |
2.0.5 | 16,948 | 6/6/2018 |
2.0.4 | 9,644 | 4/18/2018 |
2.0.3 | 2,723 | 4/12/2018 |
2.0.2 | 15,851 | 10/29/2017 |
2.0.1 | 2,988 | 9/10/2017 |
2.0.0 | 2,053 | 8/19/2017 |
1.0.3 | 7,730 | 4/18/2017 |
1.0.1 | 3,978 | 11/25/2016 |
1.0.0 | 2,415 | 7/15/2016 |
Enclosed quotes expansion