Scrima is a .NET library which parses an OData query uri into an object model which can be used to query custom data sources (IQueryable or not).

This project is a modified combination of two existing Open source projects:

• OpenApiQuery by Daniel Kuschny - MIT This early proof of concept project has greatly shown how to convert odata queries into IQueryable compatible expression
• OpenData.Core by Kyle Dwayne Thompson An extremely useful way to parse an odata query into strongly typed model objects, that could be used to query any datasource

• To use in a ASP.NET Core App (3.0+) Install-Package Scrima.OData.AspNetCore
• To use Swagger schemas with Swashbuckle Install-Package Scrima.OData.Swashbuckle
• To execute queries with EF Core Install-Package Scrima.EntityFrameworkCore

To configure the model binder to automatically parse and bind odata query string:

public class Startup
{
    // ...
    
    public void ConfigureServices(IServiceCollection services)
    {
        // Add MVC services
        services.AddMvc();
        
        // Wire-up OData binder
        services.AddScrimaODataQuery();
        
        // Apply OData schema in swashbuckle (optional)
        
        services.AddSwaggerGen(s =>
        {
            s.SwaggerDoc("MyApi", new OpenApiInfo {Title = "MyApi", Version = "v1"});
            s.AddScrimaOData(p =>
            {
                // optionally configure which parameters to show
                // by item type
                p.ConfigureOptionsPerType = (options, type) =>
                {
                    options.AllowSkipToken = type == typeof(BlogPost);
                };
            });
        }
    
    // ...
}

In your controller(s), define a Get method which accepts a parameter of ODataQuery<T>:

public ActionResult GetAll(ODataQuery<MyModel> query)
{
    // Implement query logic.
    
    var result = _context.Set<BlobPosts>().ToQueryResult(query);
    
    return Ok(new
    {
        items = result.Results,
        count = result.Count
    };
}

A partial list of supported features is shown above

Currently only filtering, ordering and paging are supported, other features like $expand, $format or aggregations are out of scope.

The name Scrima derives from the ancient Italian sword art