PartialResponseRequest.AspNetCore.ResponsePruner 1.0.0-rc

This is a prerelease version of PartialResponseRequest.AspNetCore.ResponsePruner.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package PartialResponseRequest.AspNetCore.ResponsePruner --version 1.0.0-rc
NuGet\Install-Package PartialResponseRequest.AspNetCore.ResponsePruner -Version 1.0.0-rc
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PartialResponseRequest.AspNetCore.ResponsePruner" Version="1.0.0-rc" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PartialResponseRequest.AspNetCore.ResponsePruner --version 1.0.0-rc
#r "nuget: PartialResponseRequest.AspNetCore.ResponsePruner, 1.0.0-rc"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PartialResponseRequest.AspNetCore.ResponsePruner as a Cake Addin
#addin nuget:?package=PartialResponseRequest.AspNetCore.ResponsePruner&version=1.0.0-rc&prerelease

// Install PartialResponseRequest.AspNetCore.ResponsePruner as a Cake Tool
#tool nuget:?package=PartialResponseRequest.AspNetCore.ResponsePruner&version=1.0.0-rc&prerelease

Partial response

Register a custom json output formatter that is able to prune json results based on given ?fields=... query string value. Internally it uses FieldsQueryParser and FieldsQueryInterpreter to parse and iterpret the query.

If your result is:

{
    "id": 1,
    "name": "John",
    "age": 65,
    "friends": [
        {
            "id": 2,
            "name": "Tim",
            "age": 23
        }
    ]
}

given a query of ?fields=id,friends{id,name} would result in:

{
    "id": 1,
    "friends": [
        {
            "id": 2,
            "name": "Tim"
        }
    ]
}

Usage

Use services.AddPartialResponse() to add a custom json output formatter, that will search for ?fields=... query string that would be used to prune the response for the client.

public void ConfigureServices(IServiceCollection services)
{
    // ...

    services.AddPartialResponse();

    // ...
}

Extension also allows some of customization options:

public void ConfigureServices(IServiceCollection services)
{
    // ...

    // It also supports customization by providing options
    services.AddPartialResponse(options =>
    {
        // By default, JsonPruner implementation is used, but
        // if you API wraps the responses, you can override the default
        // with WrapperAwareJsonPruner and prividing the field name which needs
        // to be unwrapped. Ex: For { page: 1, data: [ { name: "item" } ] }
        // root wrapper will be ignored and we'll start prunning from [ { name: "item" } ]
        options.Pruner = c => new WrapperAwareJsonPruner("data");

        // You can configure a custom IRequestFieldsTokensProvider implementation,
        // which is responsible for providing requested fields
        // By default, we'll search for `?fields=` query string in current request.
        options.RequestFieldsTokensProvider = c => new YourImplementation();
    });

    // ...
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.2-beta 5,457 2/28/2021
1.1.0-beta 322 6/13/2020
1.0.0-rc2 308 3/8/2020
1.0.0-rc 331 3/7/2020