Kebechet.Api.OData 1.0.0

Api.OData

A lightweight library for applying OData query options ($filter, $orderby, $skip, $top, $select, $apply) to IQueryable<T> and IEnumerable<T> collections in ASP.NET Core applications.

Features

• Apply OData query options from HTTP request to any collection
• Fluent extension methods for IQueryable and IEnumerable
• Configurable options (page size, ignored query options, null propagation)
• IODataService interface for easy mocking/testing
• Generic RegisterEntitiesFromAssemblies<TMarker>() - use your own marker interface
• Full XML documentation for IntelliSense support

Installation

dotnet add package Kebechet.Api.OData

Usage

Setup

// Basic setup with default options
services.AddOData(builder =>
{
    builder.RegisterEntitiesFromAssemblies<IEntity>(typeof(MyEntity).Assembly);
});

// With manual type registration
services.AddOData(builder =>
{
    builder.RegisterTypes(
        typeof(ProductResponse),
        typeof(OrderResponse),
        typeof(CustomerResponse)
    );
});

// With custom options
services.AddOData(
    options =>
    {
        options.PageSize = 100;
        options.IgnoreExpand = false;
        options.IgnoreCount = false;
    },
    builder =>
    {
        builder.RegisterEntitiesFromAssemblies<IEntity>(typeof(MyEntity).Assembly);
    });

In Your Service/Handler

public class ProductService
{
    private readonly AppDbContext _dbContext;
    private readonly IODataService _oDataService;

    public ProductService(AppDbContext dbContext, IODataService oDataService)
    {
        _dbContext = dbContext;
        _oDataService = oDataService;
    }

    public async Task<List<Product>> GetProductsAsync()
    {
        return await _dbContext.Products
            .Where(p => !p.IsDeleted)
            .ApplyODataQuery(_oDataService)
            .ToListAsync();
    }
}

Selective Application

public async Task<List<Product>> GetProductsAsync()
{
    return await _dbContext.Products
        .ApplyODataFilter(_oDataService)      // only $filter from request
        .OrderByDescending(p => p.CreatedAt)  // custom ordering
        .Take(50)                             // custom limit
        .ToListAsync();
}

Available Extension Methods

query.ApplyODataQuery(oDataService);       // all OData options
query.ApplyODataFilter(oDataService);      // $filter
query.ApplyODataOrderBy(oDataService);     // $orderby
query.ApplyODataPagination(oDataService);  // $skip and $top
query.ApplyODataSelect(oDataService);      // $select
query.ApplyODataApply(oDataService);       // $apply

// Conditional application
query.ApplyODataFilter(oDataService, isEnabled: shouldFilter);

Configuration Options

Query Processing Order

1. $apply
2. $filter
3. $orderby
4. $skip
5. $top
6. $select

License

This repository is licensed with the MIT license.