OData em C# (Como funciona para desenvolvedores)

Vamos criar uma classe de modelo OData simples em uma aplicação ASP.NET Core . No código a seguir, a classe abaixo expõe uma lista de serviços que podem ser consultados usando a sintaxe 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; }
}

Public Class Service
    Public Property Id As Integer
    Public Property FirstName As String
    Public Property Price As Decimal
End Class

Descrição do código

A classe Service representa uma estrutura de dados básica em C# para gerenciar um serviço. Ela inclui três propriedades: Id : um identificador inteiro para o serviço; FirstName : uma string representando o nome associado ao serviço; Price: um valor decimal indicando o preço do serviço. Essa classe pode ser usada como um bloco de construção para a criação de funcionalidades mais complexas relacionadas a serviços no desenvolvimento .NET . Também podemos usar propriedades de coleção ou de navegação, dependendo do cenário.

Veja como configurar um controlador OData em uma aplicação ASP.NET Core no Visual Studio para expor uma lista de serviços através de um endpoint OData padronizado. O exemplo a seguir demonstra uma implementação básica usando uma lista estática de serviços e habilitando funcionalidades de consulta OData na API Web:

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);
    }
}

Imports DemoOData.Models
Imports Microsoft.AspNetCore.Mvc
Imports Microsoft.AspNetCore.OData.Query
Imports Microsoft.AspNetCore.OData.Routing.Controllers

Namespace DemoOData.Controllers
	<Route("odata/[controller]")>
	Public Class ServiceController
		Inherits ODataController

		Private Shared ReadOnly Products As New List(Of Service) From {
			New Service With {
				.Id = 1,
				.FirstName = "Laptop",
				.Price = 6239.9D
			},
			New Service With {
				.Id = 2,
				.FirstName = "Smartphone",
				.Price = 2585.9D
			}
		}

		<HttpGet>
		<EnableQuery>
		Public Function [Get]() As IActionResult
			Return Ok(Products)
		End Function
	End Class
End Namespace

Descrição do código

O código fornecido define um ODataController chamado ServiceController em um aplicativo ASP.NET Core , permitindo consultar e manipular dados usando o protocolo OData. Ele encaminha solicitações para odata/Service e fornece uma lista estática de objetos Service, incluindo um laptop e um smartphone. O método Get, decorado com [EnableQuery], permite que os clientes executem consultas OData (filtragem, classificação, paginação) na lista de Produtos, retornando os resultados como um IActionResult para solicitações HTTP GET.

Registre os serviços OData no arquivo Program.cs.

Para integrar o OData em uma aplicação .NET 6, precisamos instalar e configurar os pacotes OData necessários. Isso envolve definir o modelo OData, configurar o middleware OData e configurar os serviços para suportar recursos do OData, como filtragem, ordenação e expansão.

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()
    );

Imports DemoOData.Models
Imports Microsoft.AspNetCore.OData
Imports Microsoft.OData.Edm
Imports Microsoft.OData.ModelBuilder

Private 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()

'INSTANT VB TODO TASK: Local functions are not converted by Instant VB:
'static IEdmModel GetEdmModel()
'{
'	ODataConventionModelBuilder builder = New ODataConventionModelBuilder();
'	builder.EntitySet<Service>("Services");
'	Return builder.GetEdmModel();
'}

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

Descrição do código

Este código configura o suporte a OData em uma aplicação .NET 6. Primeiro, ele importa os namespaces necessários e cria uma instância de WebApplicationBuilder. O método GetEdmModel define o modelo OData usando o ODataConventionModelBuilder, que especifica um conjunto de entidades para entidades Service. O método AddOData é então chamado para configurar os serviços OData, incluindo a ativação de select, filter, order by, count, expand e a definição de um valor máximo de 20 para os resultados da consulta. Essa configuração garante que o aplicativo possa lidar com consultas OData de forma eficaz.

O método AddOData() utiliza o método GetEdmModel(), que recupera o modelo de dados usado para consultas, formando a base de um serviço OData. Este serviço utiliza um modelo de dados abstrato conhecido como Modelo de Dados de Entidade (EDM) para definir os dados expostos. A classe ODataConventionModelBuilder gera um EDM por meio de convenções de nomenclatura padrão, minimizando os requisitos de código. Alternativamente, os desenvolvedores podem utilizar a classe ODataModelBuilder para maior controle sobre o EDM.

Captura de tela do código