webAPi OData的使用

来源:https://www.cnblogs.com/tangchun/archive/2018/03/29/8670357.html
-Advertisement-
Play Games

一、OData介紹 開放數據協議(Open Data Protocol,縮寫OData)是一種描述如何創建和訪問Restful服務的OASIS標準。 二、OData 在asp.net mvc中的用法 1、在vs中新建webApi項目 2、添加測試類型 3、開啟EF自動遷移,添加EF上下文, 4.在數 ...


一、OData介紹

開放數據協議(Open Data Protocol,縮寫OData)是一種描述如何創建和訪問Restful服務的OASIS標準。

二、OData 在asp.net mvc中的用法

  1、在vs中新建webApi項目

2、添加測試類型

 public class Product
    {
        public int Id { get; set; }

        public string ProductName
        {
            get; set;
        }
    }

3、開啟EF自動遷移,添加EF上下文,

namespace ODataTest.Migrations
{
    using System;
    using System.Data.Entity;
    using System.Data.Entity.Migrations;
    using System.Linq;
    using ODataTest.Models;

    internal sealed class Configuration : DbMigrationsConfiguration<ODataTest.Models.EFContext>
    {
        public Configuration()
        {
            AutomaticMigrationsEnabled = true;
            AutomaticMigrationDataLossAllowed = true;
        }

        protected override void Seed(ODataTest.Models.EFContext context)
        {
            //  This method will be called after migrating to the latest version.

            //  You can use the DbSet<T>.AddOrUpdate() helper extension method 
            //  to avoid creating duplicate seed data.

        }
    }
}

 

 public class EFContext : DbContext
    {

        static EFContext()
        {
            Database.SetInitializer(new MigrateDatabaseToLatestVersion<EFContext, Configuration>());
        }
        public EFContext() : base("DefaultConnection")
        {
        }

        public DbSet<Product> Products { get; set; }
    }

4.在資料庫添加一些測試數據

Id ProductName
21 產品1
22 產品2
23 產品3
24 產品4

5、在Controllers文件夾添加OData控制器

6、vs將自動生成基本的CURD,

將GetProducts方法的EnableQuery特性的AllowedQueryOptions屬性設置為:允許所有查詢AllowedQueryOptions.All

    public class ProductsController : ODataController
    {
        private EFContext db = new EFContext();

        // GET: odata/Products
        [EnableQuery(AllowedQueryOptions = AllowedQueryOptions.All)]
        public IQueryable<Product> GetProducts()
        {
            return db.Products;
        }

        // GET: odata/Products(5)
        [EnableQuery]
        public SingleResult<Product> GetProduct([FromODataUri] int key)
        {
            return SingleResult.Create(db.Products.Where(product => product.Id == key));
        }

        // PUT: odata/Products(5)
        public IHttpActionResult Put([FromODataUri] int key, Delta<Product> patch)
        {
            Validate(patch.GetEntity());

            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            Product product = db.Products.Find(key);
            if (product == null)
            {
                return NotFound();
            }

            patch.Put(product);

            try
            {
                db.SaveChanges();
            }
            catch (DbUpdateConcurrencyException)
            {
                if (!ProductExists(key))
                {
                    return NotFound();
                }
                else
                {
                    throw;
                }
            }

            return Updated(product);
        }

        // POST: odata/Products
        public IHttpActionResult Post(Product product)
        {
            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            db.Products.Add(product);
            db.SaveChanges();

            return Created(product);
        }

        // PATCH: odata/Products(5)
        [AcceptVerbs("PATCH", "MERGE")]
        public IHttpActionResult Patch([FromODataUri] int key, Delta<Product> patch)
        {
            Validate(patch.GetEntity());

            if (!ModelState.IsValid)
            {
                return BadRequest(ModelState);
            }

            Product product = db.Products.Find(key);
            if (product == null)
            {
                return NotFound();
            }

            patch.Patch(product);

            try
            {
                db.SaveChanges();
            }
            catch (DbUpdateConcurrencyException)
            {
                if (!ProductExists(key))
                {
                    return NotFound();
                }
                else
                {
                    throw;
                }
            }

            return Updated(product);
        }

        // DELETE: odata/Products(5)
        public IHttpActionResult Delete([FromODataUri] int key)
        {
            Product product = db.Products.Find(key);
            if (product == null)
            {
                return NotFound();
            }

            db.Products.Remove(product);
            db.SaveChanges();

            return StatusCode(HttpStatusCode.NoContent);
        }

        protected override void Dispose(bool disposing)
        {
            if (disposing)
            {
                db.Dispose();
            }
            base.Dispose(disposing);
        }

        private bool ProductExists(int key)
        {
            return db.Products.Count(e => e.Id == key) > 0;
        }
    }

 

7、在WebApiConfig類的Register方法裡面註冊OData路由

using System.Web.Http;
using System.Web.Http.OData.Builder;
using System.Web.Http.OData.Extensions;
using ODataTest.Models;

ODataConventionModelBuilder builder = new ODataConventionModelBuilder();
builder.EntitySet<Product>("Products");
config.Routes.MapODataServiceRoute("odata", "odata", builder.GetEdmModel());

8、運行網站就可以在瀏覽器就行OData的API測試

   常用查詢:

  查詢所有:http://localhost:64643/odata/Products

  根據主鍵進行查詢:http://localhost:64643/odata/Products(22)  【22為主鍵值】

  相等查詢:http://localhost:64643/odata/Products?$filter=ProductName eq '產品1'

      只查詢部分欄位:http://localhost:64643/odata/Products?$select=Id

  模糊查詢(這個找了老半天):http://localhost:64643/odata/Products?$filter=substringof('品1',ProductName) eq true  

  還有更多的查詢,參考,http://www.odata.org/documentation/odata-version-3-0/url-conventions/ ,在mvc中使用EF和OData基本能夠滿足所有的前端查詢,有利於快速開發API查詢介面


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • java文件下只有一個public class,並且該class含有main方法。 但是發現還可以這樣,在java文件下不定義public類,然後將main函數放在其中一個類下,這樣可以執行。如圖: 輸出結果如下: ...
  • 1. 前言 博客園終於新增了UWP的分類,我來為這個分類貢獻第一篇博客吧。 UWP有很多問題,先不說生態的事情,表單、驗證、輸入、設計等等一堆基本問題纏身。但我覺得最應該首先解決的絕對是Blend,那個隨隨便便就崩潰、報錯、比Silverlight時代還差、不能用的Blend For Visal S ...
  • 對於Web應用來說,它的界面是由瀏覽器根據HTML代碼及其引用的相關資源進行渲染後展示給用戶的結果,換句話說Web應用的界面呈現工作是由瀏覽器完成的,Web應用的原理是通過Http協議從伺服器上獲取到對應的Html代碼以及相關資源,使得瀏覽器能夠完成正確的呈現工作。 ASP.NET MVC作為一個W ...
  • 問題描述:前幾天寫個小項目的時候,用到了一個父窗體,然後繼承過來的dategridview控制項不管是屬性還是事件都不能修改。 如下圖所示: 然後我就在網上找資料,但是有關這個問題的資源甚少,或許是我不會找,總之,我根據資料得出了三點東西: ①有關這個問題的論壇或者帖子大部分都是在十年之前的了,而且並 ...
  • 方法一 : 1.創建一個全局action過濾器 (在appstart 的filterconfig中註冊 filters.Add(new LoginAttribute());) 2.不需要登錄的contoller或者action 則在該類或者action上添加該過濾器特性 (isNeed=false) ...
  • 裝完.NET CORE 2.0和IIS , 配置好網站, 報500.19 配置文件錯誤. 解決方法: 1) 安裝.NET Core Windows Server Hosting : https://go.microsoft.com/fwlink/?linkid=848766 2) IIS RESET ...
  • 我使用的是Centos7 ,其它的Linux請參考微軟文檔 微軟官方介紹文檔: https://www.microsoft.com/net/learn/get-started/linux/centos1.添加dotnet 產品 Feed 要開始安裝.NET,您需要註冊Microsoft簽名密鑰並添加 ...
  • 引用命名空間 using System.Drawing;using System.Drawing.Drawing2D;using System.Drawing.Imaging;using System.IO; 生成方法 /// <summary>生成驗證碼 /// </summary> /// <r ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...