documentation(914729):Updated custom adaptor sample

CustomAdaptor/CustomAdaptor/Controllers/OrdersController.cs

@@ -0,0 +1,78 @@
+using CustomAdaptor.Models;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.OData.Query;
+
+namespace CustomAdaptor.Controllers
+{
+    public class OrdersController : Controller
+    {
+        /// <summary>
+        /// Retrieves all orders.
+        /// </summary>
+        /// <returns>The collection of orders.</returns>
+        [HttpGet]
+        [EnableQuery]
+        public IActionResult Get()
+        {
+            var data = OrdersDetails.GetAllRecords().AsQueryable();
+            return Ok(data);
+        }
+
+        /// <summary>
+        /// Inserts a new order to the collection.
+        /// </summary>
+        /// <param name="addRecord">The order to be inserted.</param>
+        /// <returns>It returns the newly inserted record detail.</returns>
+        [HttpPost]
+        [EnableQuery]
+        public IActionResult Post([FromBody] OrdersDetails addRecord)
+        {
+            if (addRecord == null)
+            {
+                return BadRequest("Null order");
+            }
+            OrdersDetails.GetAllRecords().Insert(0, addRecord);
+            return Json(addRecord);
+        }
+
+        /// <summary>
+        /// Updates an existing order.
+        /// </summary>
+        /// <param name="key">The ID of the order to update.</param>
+        /// <param name="updateRecord">The updated order details.</param>
+        /// <returns>It returns the updated order details.</returns>
+        [HttpPatch("{key}")]
+        public IActionResult Patch(int key, [FromBody] OrdersDetails updateRecord)
+        {
+            if (updateRecord == null)
+            {
+                return BadRequest("No records");
+            }
+            var existingOrder = OrdersDetails.GetAllRecords().FirstOrDefault(order => order.OrderID == key);
+            if (existingOrder != null)
+            {
+                // If the order exists, update its properties
+                existingOrder.CustomerID = updateRecord.CustomerID ?? existingOrder.CustomerID;
+                existingOrder.EmployeeID = updateRecord.EmployeeID ?? existingOrder.EmployeeID;
+                existingOrder.ShipCountry = updateRecord.ShipCountry ?? existingOrder.ShipCountry;
+            }
+            return Json(updateRecord);
+        }
+
+        /// <summary>
+        /// Deletes an order.
+        /// </summary>
+        /// <param name="key">The ID of the order to delete.</param>
+        /// <returns>It returns the deleted record detail</returns>
+        [HttpDelete("{key}")]
+        public IActionResult Delete(int key)
+        {
+            var deleteRecord = OrdersDetails.GetAllRecords().FirstOrDefault(order => order.OrderID == key);
+            if (deleteRecord != null)
+            {
+                OrdersDetails.GetAllRecords().Remove(deleteRecord);
+            }
+            return Json(deleteRecord);
+        }
+    }
+}

CustomAdaptor/CustomAdaptor/Controllers/WeatherForecastController.cs

@@ -0,0 +1,33 @@
+using Microsoft.AspNetCore.Mvc;
+
+namespace CustomAdaptor.Controllers
+{
+    [ApiController]
+    [Route("[controller]")]
+    public class WeatherForecastController : ControllerBase
+    {
+        private static readonly string[] Summaries = new[]
+        {
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        };
+
+        private readonly ILogger<WeatherForecastController> _logger;
+
+        public WeatherForecastController(ILogger<WeatherForecastController> logger)
+        {
+            _logger = logger;
+        }
+
+        [HttpGet(Name = "GetWeatherForecast")]
+        public IEnumerable<WeatherForecast> Get()
+        {
+            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+            {
+                Date = DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+                TemperatureC = Random.Shared.Next(-20, 55),
+                Summary = Summaries[Random.Shared.Next(Summaries.Length)]
+            })
+            .ToArray();
+        }
+    }
+}

CustomAdaptor/CustomAdaptor/CustomAdaptor.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.OData" Version="9.2.1" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.6.2" />
+  </ItemGroup>
+
+</Project>

CustomAdaptor/CustomAdaptor/CustomAdaptor.csproj.user

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="Current" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <ActiveDebugProfile>https</ActiveDebugProfile>
+  </PropertyGroup>
+</Project>

CustomAdaptor/CustomAdaptor/CustomAdaptor.http

@@ -0,0 +1,6 @@
+@CustomAdaptor_HostAddress = http://localhost:5286
+
+GET {{CustomAdaptor_HostAddress}}/weatherforecast/
+Accept: application/json
+
+###

CustomAdaptor/CustomAdaptor/CustomAdaptor.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.13.35919.96 d17.13
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CustomAdaptor", "CustomAdaptor.csproj", "{94144981-A808-4936-9BE1-BABA4C056FA8}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{94144981-A808-4936-9BE1-BABA4C056FA8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{94144981-A808-4936-9BE1-BABA4C056FA8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{94144981-A808-4936-9BE1-BABA4C056FA8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{94144981-A808-4936-9BE1-BABA4C056FA8}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {5F94210D-948B-4031-A1AC-5D39E7CEEB4C}
+	EndGlobalSection
+EndGlobal

CustomAdaptor/CustomAdaptor/Models/OrdersDetails.cs

@@ -0,0 +1,44 @@
+using System.ComponentModel.DataAnnotations;
+
+namespace CustomAdaptor.Models
+{
+    public class OrdersDetails
+    {
+        public static List<OrdersDetails> order = new List<OrdersDetails>();
+        public OrdersDetails()
+        {
+
+        }
+        public OrdersDetails(
+        int OrderID, string CustomerId, int EmployeeId, string ShipCountry)
+        {
+            this.OrderID = OrderID;
+            this.CustomerID = CustomerId;
+            this.EmployeeID = EmployeeId;
+            this.ShipCountry = ShipCountry;
+        }
+
+        public static List<OrdersDetails> GetAllRecords()
+        {
+            if (order.Count() == 0)
+            {
+                int code = 10000;
+                for (int i = 1; i < 10; i++)
+                {
+                    order.Add(new OrdersDetails(code + 1, "ALFKI", i + 0, "Denmark"));
+                    order.Add(new OrdersDetails(code + 2, "ANATR", i + 2, "Brazil"));
+                    order.Add(new OrdersDetails(code + 3, "ANTON", i + 1, "Germany"));
+                    order.Add(new OrdersDetails(code + 4, "BLONP", i + 3, "Austria"));
+                    order.Add(new OrdersDetails(code + 5, "BOLID", i + 4, "Switzerland"));
+                    code += 5;
+                }
+            }
+            return order;
+        }
+        [Key]
+        public int? OrderID { get; set; }
+        public string? CustomerID { get; set; }
+        public int? EmployeeID { get; set; }
+        public string? ShipCountry { get; set; }
+    }
+}

CustomAdaptor/CustomAdaptor/Program.cs

@@ -0,0 +1,50 @@
+using CustomAdaptor.Models;
+using Microsoft.AspNetCore.OData;
+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();
+
+// Create an ODataConventionModelBuilder to build the OData model
+var modelBuilder = new ODataConventionModelBuilder();
+
+// Register the "Orders" entity set with the OData model builder
+modelBuilder.EntitySet<OrdersDetails>("Orders");
+
+// Add controllers with OData support to the service collection
+
+var recordCount = OrdersDetails.GetAllRecords().Count;
+builder.Services.AddControllers().AddOData(
+    options => options
+        .Count()
+        .Filter() //searching and filtering
+        .Select()
+        .Expand()
+        .OrderBy()
+        .SetMaxTop(recordCount)
+        .AddRouteComponents("odata", modelBuilder.GetEdmModel()));
+
+var app = builder.Build();
+app.UseDefaultFiles();
+app.UseStaticFiles();
+// Configure the HTTP request pipeline.
+if (app.Environment.IsDevelopment())
+{
+    app.UseSwagger();
+    app.UseSwaggerUI();
+}
+
+app.UseHttpsRedirection();
+
+app.UseAuthorization();
+
+app.MapControllers();
+
+app.Run();

CustomAdaptor/CustomAdaptor/Properties/launchSettings.json

@@ -0,0 +1,41 @@
+{
+  "$schema": "http://json.schemastore.org/launchsettings.json",
+  "iisSettings": {
+    "windowsAuthentication": false,
+    "anonymousAuthentication": true,
+    "iisExpress": {
+      "applicationUrl": "http://localhost:26717",
+      "sslPort": 44324
+    }
+  },
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "launchUrl": "swagger",
+      "applicationUrl": "http://localhost:5286",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": true,
+      "launchUrl": "swagger",
+      "applicationUrl": "https://localhost:7295;http://localhost:5286",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "IIS Express": {
+      "commandName": "IISExpress",
+      "launchBrowser": true,
+      "launchUrl": "swagger",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

CustomAdaptor/CustomAdaptor/WeatherForecast.cs

@@ -0,0 +1,13 @@
+namespace CustomAdaptor
+{
+    public class WeatherForecast
+    {
+        public DateOnly Date { get; set; }
+
+        public int TemperatureC { get; set; }
+
+        public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+
+        public string? Summary { get; set; }
+    }
+}

CustomAdaptor/CustomAdaptor/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

CustomAdaptor/CustomAdaptor/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}

CustomAdaptor/CustomAdaptor/wwwroot/index.html

@@ -0,0 +1,30 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>EJ2 Grid</title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="description" content="Javascript Grid Control">
+    <meta name="author" content="Syncfusion">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-base/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-grids/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-buttons/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-popups/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-richtexteditor/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-navigations/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-dropdowns/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-lists/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-inputs/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-calendars/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-notifications/styles/bootstrap5.css" rel="stylesheet">
+    <link href="https://cdn.syncfusion.com/ej2/26.1.35/ej2-splitbuttons/styles/bootstrap5.css" rel="stylesheet">
+    <script src="https://cdn.syncfusion.com/ej2/26.1.35/dist/ej2.min.js" type="text/javascript"></script>
+    <script src="https://cdn.syncfusion.com/ej2/syncfusion-helper.js" type="text/javascript"></script>
+</head>
+<body>
+    <div id="container">
+        <div id="Grid"></div>
+    </div>
+    <script type="module" src="js/index.js"></script>
+</body>
+</html>

CustomAdaptor/CustomAdaptor/wwwroot/js/CustomAdaptor.js

@@ -0,0 +1,22 @@
+export class CustomAdaptor extends ej.data.ODataV4Adaptor {
+    processQuery(dm, query) {
+        dm.dataSource.url = 'https://localhost:7295/odata/orders'; //Change the url.
+        query.addParams('Syncfusion Grid', 'true'); // Add the additional parameter.
+        return super.processQuery.apply(this, arguments);
+    }
+
+    beforeSend(dm, request, settings) {
+        request.headers.set('Authorization', `true`);
+        super.beforeSend(dm, request, settings);
+    }
+
+    processResponse() {
+        let i = 0;
+        const original = super.processResponse.apply(this, arguments);
+        // Adding serial number.
+        if (original.result) {
+            original.result.forEach((item) => ej.base.setValue('SNo', ++i, item));
+        }
+        return original;
+    }
+}