OData C# (Cómo Funciona para Desarrolladores)

Vamos a crear una clase de modelo OData simple en una aplicación ASP.NET Core. En el siguiente código, la clase a continuación expondrá una lista de servicios que se pueden consultar usando la sintaxis OData.

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

public class Service
{
    public int Id { get; set; } 
    public string FirstName { get; set; }
    public decimal Price { get; set; }
}

Descripción del código

La clase Service representa una estructura de datos básica en C# para la gestión de un servicio. Incluye tres propiedades: Id : Un identificador entero del servicio. FirstName : Una cadena que representa el nombre asociado al servicio. Price: Un valor decimal que indica el precio del servicio. Esta clase puede utilizarse como elemento fundamental para crear funcionalidades más complejas relacionadas con servicios en el desarrollo .NET. También podemos usar propiedades de colección o de navegación basadas en el escenario.

Aquí se muestra cómo puede configurar un controlador OData en una aplicación ASP.NET Core en Visual Studio para exponer una lista de servicios a través de un punto final OData estandarizado. El siguiente ejemplo demuestra una implementación básica utilizando una lista estática de servicios y habilitando funcionalidades de consulta OData en Web API:

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

using DemoOData.Models;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.OData.Query;
using Microsoft.AspNetCore.OData.Routing.Controllers;

namespace DemoOData.Controllers
{
    [Route("odata/[controller]")]
    public class ServiceController : ODataController
    {
        private static readonly List<Service> Products = new List<Service>
        {
            new Service { Id = 1, FirstName = "Laptop", Price = 6239.9M },
            new Service { Id = 2, FirstName = "Smartphone", Price = 2585.9M }
        };

        [HttpGet]
        [EnableQuery]
        public IActionResult Get() => Ok(Products);
    }
}

Descripción del código

El código proporcionado define un ODataController llamado ServiceController en una aplicación ASP.NET Core, habilitando la consulta y manipulación de datos usando el protocolo OData. Dirige las solicitudes a odata/Service y sirve una lista estática de objetos Service, incluyendo una laptop y un teléfono inteligente. El método Get, decorado con [EnableQuery], permite a los clientes realizar consultas OData (filtrado, ordenamiento, paginación) en la lista de Productos, devolviendo los resultados como un IActionResult para solicitudes HTTP GET.

Registrar Servicios OData en el Program.cs

Para integrar OData en una aplicación .NET 6, necesitamos instalar y configurar los paquetes necesarios de OData. Esto implica definir el modelo OData, configurar el middleware OData, y configurar servicios para admitir características de OData como filtrado, ordenamiento y expansión.

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

using DemoOData.Models;
using Microsoft.AspNetCore.OData;
using Microsoft.OData.Edm;
using Microsoft.OData.ModelBuilder;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

static IEdmModel GetEdmModel()
{
    ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
    builder.EntitySet<Service>("Services");
    return builder.GetEdmModel();
}

builder.Services.AddControllers()
    .AddOData(options => options
        .AddRouteComponents("odata", GetEdmModel())
        .Select()
        .Filter()
        .OrderBy()
        .SetMaxTop(20)
        .Count()
        .Expand()
    );

Descripción del código

Este código configura el soporte OData en una aplicación .NET 6. Primero, importa los espacios de nombres necesarios y crea una instancia de WebApplicationBuilder. El método GetEdmModel define el modelo OData usando el ODataConventionModelBuilder, que especifica un conjunto de entidades para entidades Service. Luego se llama al método AddOData para configurar los servicios OData, incluyendo la habilitación de select, filter, order by, count, expand, y estableciendo un valor máximo top de 20 para los resultados de consulta. Esta configuración asegura que la aplicación pueda manejar consultas OData de manera efectiva.

El método AddOData() emplea el método GetEdmModel(), que recupera el modelo de datos usado para consultar, formando la base de un servicio OData. Este servicio utiliza un modelo de datos abstracto conocido como Modelo de Datos de Entidad (EDM) para definir los datos expuestos. La clase ODataConventionModelBuilder genera un EDM a través de convenciones de nombres predeterminadas, minimizando los requisitos de código. Alternativamente, los desarrolladores pueden utilizar la clase ODataModelBuilder para un mayor control sobre el EDM.

Captura de pantalla del código