Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/enisn/AutoFilterer
AutoFilterer is a mini filtering framework library for dotnet. The main purpose of the library is to generate LINQ expressions for Entities over DTOs automatically. The first aim is to be compatible with Open API 3.0 Specifications
https://github.com/enisn/AutoFilterer
aspnetcore aspnetcoremvc automatic-filtering automation csharp dotnet dtos filter filtering linq paginations query query-engine querystring range sorting swagger
Last synced: about 1 month ago
JSON representation
AutoFilterer is a mini filtering framework library for dotnet. The main purpose of the library is to generate LINQ expressions for Entities over DTOs automatically. The first aim is to be compatible with Open API 3.0 Specifications
- Host: GitHub
- URL: https://github.com/enisn/AutoFilterer
- Owner: enisn
- License: mit
- Created: 2019-07-10T17:30:01.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2024-03-19T07:25:10.000Z (9 months ago)
- Last Synced: 2024-05-01T14:50:30.068Z (8 months ago)
- Topics: aspnetcore, aspnetcoremvc, automatic-filtering, automation, csharp, dotnet, dtos, filter, filtering, linq, paginations, query, query-engine, querystring, range, sorting, swagger
- Language: C#
- Homepage:
- Size: 4.86 MB
- Stars: 434
- Watchers: 12
- Forks: 36
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- RSCG_Examples - AutoFilterer.Generators
README
# AutoFilterer
AutoFilterer is a mini filtering framework library for dotnet.
The main purpose of the library is to generate LINQ expressions for Entities over DTOs automatically. Creating queries without writing any expression code is the most powerful feature that is provided. The first aim of AutoFilterer is to be compatible with Open API 3.0 Specifications, unlike oData & GraphQL.
> This library **does not** generate database queries directly. It generates LINQ Expressions.
You can check [Documentation](https://enisn-projects.io/docs/en/AutoFilterer/) for getting started.
[](https://www.nuget.org/packages/AutoFilterer/)
[](https://enisn-projects.io/docs/en/AutoFilterer/)
[](https://www.codefactor.io/repository/github/enisn/autofilterer)
[](https://github.com/enisn/AutoFilterer/actions/workflows/dotnetcore.yml)
## Getting Started
- Install `AutoFilterer` NuGet package from [here](https://www.nuget.org/packages/AutoFilterer/).
Vsit [visit documentation](https://enisn-projects.io/docs/en/AutoFilterer/) to learn how to use AutoFilterer.
[↗️ Open in Visual Studio Code](https://open.vscode.dev/enisn/AutoFilterer)
***
## Usage
A quick example is presented below. Reading [documentation](https://enisn-projects.io/docs/en/AutoFilterer/) is highly recommended for detailed features.
- Create a filter model and make sure property names match to Entity properties.
```csharp
public class ProductFilter : PaginationFilterBase
{
public Range Price { get; set; }
[ToLowerContainsComparison]
public string Name { get; set; }
[StringFilteringOptions(StringFilterOption.Equals)]
public string Locale { get; set; }
}
```
```csharp
public IActionResult GetProducts([FromQuery]ProductFilter filter)
{
var products = db.Products.ApplyFilter(filter).ToList();
return Ok(products);
}
```
Don't forget to [visit Wiki](../../wiki) for better understanding of usage.
***
## AutoFilterer.Swagger
All parameters support OpenAPI 3.0 Specifications 👍
Improve your swagger documentation via using [AutoFilterer.Swagger](https://github.com/enisn/AutoFilterer/tree/master/src/AutoFilterer.Swagger)
***
## AutoFilterer.Generators
AutoFilterer.Generators aims to generate filter objects from entities automatically via using [dotnet source generators](https://devblogs.microsoft.com/dotnet/introducing-c-source-generators/).
Visit [documentation of Generators](https://enisn-projects.io/docs/en/AutoFilterer/latest/generators/AutoFilterer-Generators)
---
## Performance
See Benchmark Results from [here](https://enisn-projects.io/docs/en/AutoFilterer/latest/Benchmark-Results)
---
## Sponsors
- [gpproton](https://github.com/gpproton)
- [Sumgon](https://github.com/Sumgon)
---
## Stats
