ResponseSchemaHeader 0.7.0

.NET Core 2.0
NuGet\Install-Package ResponseSchemaHeader -Version 0.7.0
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.
dotnet add package ResponseSchemaHeader --version 0.7.0
<PackageReference Include="ResponseSchemaHeader" Version="0.7.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ResponseSchemaHeader --version 0.7.0
#r "nuget: ResponseSchemaHeader, 0.7.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install ResponseSchemaHeader as a Cake Addin
#addin nuget:?package=ResponseSchemaHeader&version=0.7.0

// Install ResponseSchemaHeader as a Cake Tool
#tool nuget:?package=ResponseSchemaHeader&version=0.7.0

ResponseSchemaHeader

ASP.NET Core API middleware that allows client to specify what part of the response they need, and cuts out everything else before it's sent to the client.

Features

  • One line initialization
  • Supports object and array responses
  • Supports nested properties
  • Supported response content types:
    • JSON

Initialization

To start using the middleware just add UseResponseSchemaHeader into Statup.cs before UseEndpoints:

public void Configure(IApplicationBuilder app)
{
    app.UseResponseSchemaHeader();
}

Usage

Now your client is able to add ResponseSchema header to any request, and ASP.NET will remove any properties that are not listed there. If client needs everything to be returned, ResponseSchema header can be omitted.

ResponseSchema should have following structure:

[ 
    "topLevelProperty1", 
    "topLevelProperty2", 
    {
        "topLevelProperty3": [
            "nestedProperty1"
        ] 
    } 
]

If all nested properties from topLevelProperty3 need to be included, add it as another string array item.

For example, let's say your action returns following information:

[
    {
        "registration": "AA07AMM",
        "modelCode": "nissan-note",
        "color": "Turquoise",
        "year": 2007,
        "vehicleModel": {
            "code": "nissan-note",
            "manufacturerCode": "nissan",
            "name": "NOTE",
            "manufacturer": {
                "code": "nissan",
                "name": "NISSAN"
            }
        }
    },
    {
        "registration": "AAC792H",
        "modelCode": "hyundai-i10",
        "color": "Silver",
        "year": 1975,
        "vehicleModel": {
            "code": "volkswagen-up",
            "manufacturerCode": "volkswagen",
            "name": "UP",
            "manufacturer": {
                "code": "volkswagen",
                "name": "VOLKSWAGEN"
            }
        }
    },

And you only need registration and vehicleModel.code on your client. After adding this header to the request (it's case insensitive by default):

ResponseSchema: [ "Registration", "ModelCode", { "vehicleModel": [ "code" ] } ]

Response will be:

[
    {
        "registration": "AA07AMM",
        "vehicleModel": {
            "code": "nissan-note"
        }
    },
    {
        "registration": "AAY452D",
        "vehicleModel": {
            "code": "volkswagen-up"
        }
    }
]
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
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
Compatible target framework(s)
Additional computed target framework(s)
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
0.7.0 159 7/7/2021