PartialResponse provides JSON partial response (partial resource) support for ASP.NET Web API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
samples/PartialResponse.Samples
src/PartialResponse
test/PartialResponse.Tests
.appveyor.yml
.gitignore
LICENSE
NOTICE
PartialResponse.sln
PartialResponse.snk
README.md
nuget.config
stylecop.json

README.md

ASP.NET Web API Partial Response

apache nuget appveyor sonarqube codecov

PartialResponse provides JSON partial response (partial resource) support for ASP.NET Web API. This package is also available for ASP.NET Core MVC.

Getting started

First, add a dependency to WebApi.PartialResponse using the NuGet package manager (console):

Install-Package WebApi.PartialResponse

Then, remove the JsonMediaTypeFormatter from the output formatters and add the PartialJsonMediaTypeFormatter. The fields parameter value, which is used to filter the API response, is case-sensitive by default, but this can be changed using the PartialJsonMediaTypeFormatter.IgnoreCase property:

configuration.Formatters.Clear();
configuration.Formatters.Add(new PartialJsonMediaTypeFormatter() { IgnoreCase = true });

For OWIN self-host or HTTP self-host applications, add the PartialJsonActionFilter to the filters:

configuration.Filters.Add(new PartialJsonActionFilter());

That's it!

Understanding the fields parameter

The fields parameter filters the API response so that the response only includes a specific set of fields. The fields parameter lets you remove nested properties from an API response and thereby reduce your bandwidth usage.

The following rules explain the supported syntax for the fields parameter value, which is loosely based on XPath syntax:

  • Use a comma-separated list (fields=a,b) to select multiple fields.
  • Use an asterisk (fields=*) as a wildcard to identify all fields.
  • Use parentheses (fields=a(b,c)) to specify a group of nested properties that will be included in the API response.
  • Use a forward slash (fields=a/b) to identify a nested property.

In practice, these rules often allow several different fields parameter values to retrieve the same API response. For example, if you want to retrieve the playlist item ID, title, and position for every item in a playlist, you could use any of the following values:

  • fields=items/id,playlistItems/snippet/title,playlistItems/snippet/position
  • fields=items(id,snippet/title,snippet/position)
  • fields=items(id,snippet(title,position))

Note: As with all query parameter values, the fields parameter value must be URL encoded. For better readability, the examples in this document omit the encoding.

Note: Due to the relatively slow performance of LINQ to JSON (Json.NET), the usage of PartialJsonOutputFormatter has a performance impact compared to the regular Json.NET serializer. Because of the reduced traffic, the overhead in time could be neglected.