Examples in this repo show how to fully leverage content negotiation in ASP.NET. The focus is primarily on usage for HTTP (REST) APIs.
Examples and approaches assume understanding of HTTP, MediaTypes, and content negotiation via the Accept header. See Content Negotiation - MDN for a good overview of the concepts.
The examples (below) demonstrate a progression of usage, starting with what is included in the ASP.NET Core framework (see ContentNegotiationExample). However the primary example is the Codec Example.
Demonstrates how to use input and output formatters in ASP.NET for content negotiation.
This example is primarly aimed at showing what ASP.NET provides in the framework. However, the framework's approach is challenging to use.
See src/ContentNegotiationExample for the solution.
See the ContentNegotiationExample Readme for details on how to run and test the endpoints.
Introduce the concepts of codecs (encoders / decoders) and transcoders. These enable us to use the formatting and parsing logic anywhere, including in client SDKs and/or data persistence.
See the CodecExample for details on how to run and test the server endpoints.
See the CodecExample Common Library for codecs, base classes, and the transcoder implementations.
See the CodecExample Client CLI for an example of using the transcoder and codecs on the client.
See the CodecExample Sqlite Data Repository for an example of using the transcoder and codecs when saving to the database.
See the CodecExample Protobuf Codecs for protobuf codec examples, which use a binary encoding for compact representations.