![\"Vitamina](\"http:\/\/blogs.encamina.com\/piensa-en-software-desarrolla-en-colores\/wp-content\/uploads\/sites\/21\/2019\/11\/Vitamina-tu-API-.Net-Core-con-Odata.jpg\")
<\/p>\n<\/p>\n
Siempre has querido definir tu API para que realice consultas de una forma poderosa (como las disponibles en Azure Search<\/strong>)\u00a0 y lo sabes. En este post veremos qu\u00e9 es OData<\/strong> y c\u00f3mo integrarlo en nuestra API realizada en .NET Core para vitaminizarlas de una manera muy sencilla.<\/p>\n <\/p>\n NOTA: La implementaci\u00f3n actual de OData s\u00f3lo puede admitir hasta ASP.NET Core 2.2. <\/strong>Para ASP.NET Core 3.0 est\u00e1 previsto que se libere en el segundo trimestre de 2020.<\/p>\n OData<\/strong> (Open Data Protocol<\/strong>) es un est\u00e1ndar que define un conjunto de mejores pr\u00e1cticas para la construcci\u00f3n y consumo de RESTful APIs, permitiendo a los desarrolladores la capacidad de desarrollar Queryable APIs<\/strong>. Este protocolo utiliza otras tecnolog\u00edas ya reconocidas como HTTP<\/strong>, AtomPub<\/strong> o JSON<\/strong> y permite a cualquier cliente obtenga informaci\u00f3n de cualquier fuente bas\u00e1ndose en:<\/p>\n Para m\u00e1s informaci\u00f3n pod\u00e9is visitar https:\/\/www.odata.org\/<\/a><\/p>\n La potencia de OData<\/strong> nos da la posibilidad, entre otras, de:<\/p>\n Lo primero que debemos hacer es descargarnos el siguiente paquete Nuget: Microsoft.AspNetCore.OData<\/a><\/p>\n Una vez instalado vamos a configurar OData<\/strong> en la inicializaci\u00f3n de nuestra API. En nuestra clase Startup.cs<\/strong> debemos agregar el servicio de OData<\/strong> de la siguiente forma:<\/p>\n Hay que tener en cuenta que la versi\u00f3n 2.2 de .Net Core tiene habilitado por defecto el \u201cendpoint routing\u201d. <\/strong><\/em>Tenemos que deshabilitarlo para no recibir un bonito mensaje como este:<\/p>\n System.InvalidOperationException: ‘Cannot use ‘Microsoft.AspNet.OData.Routing.ODataRoute’ with Endpoint Routing.’<\/strong><\/p>\n Luego configuramos el routing<\/strong> de la siguiente forma:<\/p>\n Comentemos algo de estas lineas de c\u00f3digo.<\/p>\n Si os fij\u00e1is en la \u00faltima l\u00ednea, se configura EDM<\/strong> (Entity Data Model<\/strong>) para definir el mapeo de forma correcta entre nuestras entidades de datos en entidades que usa OData<\/strong> para realizar las operaciones de filtro, selecci\u00f3n, ordenaci\u00f3n, etc.<\/p>\n Con esto ya tendr\u00edamos configurado OData<\/strong> en nuestra API. \u00bfSencillo no?<\/p>\n Echemos un ojo a los controladores.<\/p>\n Lo primero que debemos tener en cuenta es que el controlador heredar\u00e1 la clase ODataController<\/strong>. Despu\u00e9s, al tener habilitado el routing<\/strong> de OData<\/strong>, estableceremos a nivel de controlador el atributo ODataRoutePrefix<\/strong>, indicando el prefijo (como ya hab\u00edamos avanzado).<\/p>\n Decoraremos con el atributo ODataRoute <\/strong>y habilitaremos las consultas OData <\/strong>con EnableQuery<\/strong> nuestras acciones del controlador.<\/p>\n \u00a0<\/strong>Ejecutamos nuestra API y vemos algunos tipos de consultas que podemos hacer (para m\u00e1s informaci\u00f3n de la sintaxis OData Query, puedes visitar: https:\/\/www.odata.org\/documentation\/odata-version-2-0\/uri-conventions\/<\/a>).<\/p>\n En el c\u00f3digo se adjuntar\u00e1 una colecci\u00f3n Postman<\/strong> para que pod\u00e1is trastear. Algunas consultas que podemos hacer son las siguientes:<\/p>\n https:\/\/localhost:5001\/api\/Person<\/strong><\/p>\n \u00a0https:\/\/localhost:5001\/api\/Person?$filter=FirstName eq ‘Helen’<\/strong><\/p>\n https:\/\/localhost:5001\/api\/Person(3)<\/strong><\/p>\n https:\/\/localhost:5001\/api\/Person?$filter=FirstName eq ‘Helen’ &$select=FirstName,LastName<\/strong><\/p>\n https:\/\/localhost:5001\/api\/Person?$filter=FirstName eq ‘Helen’&$orderby=LastName desc<\/strong><\/p>\n La conclusi\u00f3n que sacamos de OData es que mola y mucho \ud83d\ude42 Nos da potencia para realizar consultas bestial y encima la configuraci\u00f3n en nuestra API en .NET Core es muy sencilla.<\/p>\n El c\u00f3digo de ejemplo junto con una colecci\u00f3n de Postman y una base de datos de prueba lo pod\u00e9is descargar desde GitHub<\/a><\/p>\n Happy coding!!<\/p>\n<\/span>","protected":false},"excerpt":{"rendered":" Siempre has querido definir tu API para que realice consultas de una forma poderosa (como las disponibles en Azure Search)\u00a0 y lo sabes. En este post veremos qu\u00e9 es OData y c\u00f3mo integrarlo en nuestra API realizada en .NET Core … Continue reading \u00bfQu\u00e9 es OData?<\/h1>\n
\n
\n
Al l\u00edo que es lo que nos mola<\/h1>\n
\r\n\r\npublic void ConfigureServices(IServiceCollection services)\r\n{\r\n services.AddOData();\r\n services.AddODataQueryFilter();\r\n\r\n services.AddDbContext<AdventureWorks2016Context>(options => options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));\r\n\r\n services.AddMvc(options =>\r\n {\r\n options.EnableEndpointRouting = false;\r\n }).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);\r\n}\r\n\r\n<\/pre>\n\r\n\r\npublic static void Configure(IApplicationBuilder app, IHostingEnvironment env)\r\n{\r\n if (env.IsDevelopment())\r\n {\r\n app.UseDeveloperExceptionPage();\r\n }\r\n else\r\n {\r\n \/\/ The default HSTS value is 30 days. You may want to change this for production scenarios, see https:\/\/aka.ms\/aspnetcore-hsts.\r\n app.UseHsts();\r\n }\r\n\r\n app.UseHttpsRedirection();\r\n app.UseMvc(routeBuilder =>;\r\n {\r\n routeBuilder.EnableDependencyInjection();\r\n routeBuilder.Select().Filter().OrderBy().Expand().Count().MaxTop(10);\r\n\r\n routeBuilder.MapODataServiceRoute("api", "api", GetEdmModel(app.ApplicationServices));\r\n });\r\n}\r\n\r\nprivate static IEdmModel GetEdmModel(IServiceProvider serviceProvider)\r\n{\r\n ODataModelBuilder builder = new ODataConventionModelBuilder(serviceProvider);\r\n\r\n builder.EntitySet<Person>("Person")\r\n .EntityType\r\n .Filter()\r\n .Count()\r\n .Expand()\r\n .OrderBy()\r\n .Page()\r\n .Select();\r\n .. .. ..\r\n return builder.GetEdmModel();\r\n}\r\n\r\n<\/pre>\nL\u00edneas de c\u00f3digo<\/h3>\n
\n
Controladores<\/h3>\n
\r\n\r\nusing AspNetCoreOData.Database;\r\nusing Microsoft.AspNet.OData;\r\nusing Microsoft.AspNet.OData.Query;\r\nusing Microsoft.AspNet.OData.Routing;\r\nusing Microsoft.AspNetCore.Mvc;\r\nusing System.Linq;\r\n\r\nnamespace AspNetCoreOData.Controllers\r\n{\r\n [ODataRoutePrefix("Person")]\r\n public class PersonController : ODataController\r\n {\r\n private AdventureWorks2016Context db;\r\n\r\n public PersonController(AdventureWorks2016Context adventureWorks2016Context)\r\n {\r\n db = adventureWorks2016Context;\r\n }\r\n\r\n [ODataRoute]\r\n [EnableQuery(PageSize = 20, AllowedQueryOptions = AllowedQueryOptions.All)]\r\n [HttpGet]\r\n public IActionResult Get()\r\n {\r\n return Ok(db.Person.AsQueryable());\r\n }\r\n\r\n [ODataRoute("({key})")]\r\n [EnableQuery(PageSize = 20, AllowedQueryOptions = AllowedQueryOptions.All)]\r\n [HttpGet]\r\n public IActionResult Get([FromODataUri] int key)\r\n {\r\n return Ok(db.Person.Find(key));\r\n }\r\n }\r\n}\r\n\r\n<\/pre>\n\r\n\r\n[ODataRoutePrefix("Person")]\r\n\r\n<\/pre>\n\r\n\r\n[ODataRoute("({key})")]\r\n[EnableQuery(PageSize = 20, AllowedQueryOptions = AllowedQueryOptions.All)]\r\n\r\n<\/pre>\nPreparados, listos\u2026 \u00a1YA!<\/strong><\/h1>\n
\n
\n
\n
\n
\n
Conclusiones<\/strong><\/h1>\n