QueryQuiver 1.2.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package QueryQuiver --version 1.2.0
                    


                    

                
NuGet\Install-Package QueryQuiver -Version 1.2.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. 
<PackageReference Include="QueryQuiver" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="QueryQuiver" Version="1.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="QueryQuiver" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add QueryQuiver --version 1.2.0
                    


                    

                
#r "nuget: QueryQuiver, 1.2.0"
#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. 
#:package QueryQuiver@1.2.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=QueryQuiver&version=1.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=QueryQuiver&version=1.2.0
                    


                            Install as a Cake Tool

QueryQuiver

Simple way to add filtering, pagination and sorting to you API.

Instalation

You can instal QueryQuiver via NuGet

Install-Package QueryQuiver

Or via .NET CLI

dotnet add package QueryQuiver

Usage

QueryQuiver is using query params of API to filter out results. All you need to do is to pass query params to extension method ApplyFilters().

Implementation

[HttpGet]
public async Task<ActionResult<IEnumerable<Person>>> GetPeople([FromQuery] IDictionary<string, string[]> filters)
{
    return Ok(await dbContext.People.ApplyFilters(filters).ToListAsync());
}

Request

Data are passed as query params in request. Name of properties in request has to match model excatly to work.
Format for filter is as follow:

{{propertyName}}={{filterOperator}}:{{value}}
rating=ge:4

Spaces

You can use spaces in values (use encoding in quqery params)

Case sensitivy

Both property names and values are case insensitve

Nested/Owned properties

For nested properties use | to separate path to property

job|title=eq:Miner

Pagination

Pagination requires two parameters
page (offset of results) - default 0
pageSize (number of results) - default 20
If parametr is not support default values are used

Sort

Currently only one sorting parametr is allowed
{{sort}}={{propertyName}}:{{desc/asc}}

Filter operators
Operation Query
Equal eq
NotEqual ne
GreaterThan gt
GreaterThanOrEqual ge
LessThan lt
LessThanOrEqual le
Contains ct
StartsWith sw
EndsWith ew
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • net8.0

    • No dependencies.

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
2.1.0 1,056 9/17/2024
2.0.0 560 8/31/2024
1.2.0 1,562 7/26/2024
1.1.0 996 7/2/2024
1.0.0 641 6/9/2024