Services
Technology Web App Development Mobile App Development Windows App Development Database Development UI/UX Development Cloud Development SEO Digital Marketing Guest Posting Content Writing Artificial Intelligence Data Science ERP Development CRM Development CMS Development LMS Development Business Listing Blockchain Technology Startup Promotion
Products
Data Converter Cleaner TUC - Unit Converter Import Export Survey Manager Tweet Controller
Developer
Article Blog Forum Interview Beginner News Startup Quiz
Users
Career
Apply Job Internship
Pricing
Login Sign Up Get a Quote

interview

home / developersection / interviews / what is content negotiation in web api?
Ask Question

What is content negotiation in Web API?

Ravi Vishwakarma 628 13 Jun 2025
c# c#
Updated 13 Jun 2025
Ravi Vishwakarma
Ravi Vishwakarma

IT-Hardware & Networking

Ravi Vishwakarma is a dedicated Software Developer with a passion for crafting efficient and innovative solutions. With a keen eye for detail and years of experience, he excels in developing robust software systems that meet client needs. His expertise spans across multiple programming languages and technologies, making him a valuable asset in any software development project.

Message

1 Answers

Ravi Vishwakarma
Ravi Vishwakarma 13 Jun 2025
Report Abuse

Content Negotiation (or conneg) in ASP.NET Web API is the process of determining the best format (media type) to return in the response, based on what the client can accept.

It's how the server chooses JSON, XML, or other formats based on:

  • The client's Accept header
  • Available formatters on the server

How It Works

When a client sends a request to the API, it may include an Accept header:

GET /api/products
Accept: application/json

ASP.NET Web API:

  • Looks at the Accept header.
  • Matches it with the available media type formatters (e.g., JSON, XML).
  • Serializes the response in the best matching format.

🧪 Example

Request:

GET /api/products
Accept: application/xml

Response:

<Product><Id>1</Id><Name>Phone</Name></Product>

If the client had sent:

Accept: application/json

Then the server responds with:

{ "Id": 1, "Name": "Phone" }

Built-in Formatters in Web API

Formatter Media Type(s)
JsonMediaTypeFormatter application/json, text/json
XmlMediaTypeFormatter application/xml, text/xml

You can also create custom formatters for CSV, YAML, etc.

Server Configuration (Optional)

You can control or extend formatters in WebApiConfig.cs:

config.Formatters.JsonFormatter.SupportedMediaTypes
      .Add(new MediaTypeHeaderValue("text/html"));

To remove XML support:

config.Formatters.Remove(config.Formatters.XmlFormatter);

Use Cases

Use Case Benefit
Mobile apps prefer JSON Lightweight, faster parsing
Legacy systems require XML Compatibility
Browser default is HTML Can force JSON via custom formatter

Force Format without Accept Header

You can use URL query strings or route extensions:

/api/products?format=json
/api/products.json

Requires custom logic or third-party packages (e.g., WebApiContrib.Formatting).

Summary

Feature Description
Definition Process of selecting response format based on client preference
Header Used Accept
Formats Supported JSON, XML (by default)
Customizable Yes, you can add/remove/override formatters
advertising