主頁 > .NET開發 > Asp.Net WebAPI的簡介及創建

Asp.Net WebAPI的簡介及創建

2020-09-10 09:22:01 .NET開發

一.WebAPI簡介

    ASP.NET Web API 是一種框架,用于輕松構建可以由多種客戶端(包括瀏覽器和移動設備)訪問的 HTTP 服務,ASP.NET Web API 是一種用于在 .NET Framework 上構建 RESTful 應用程式的理想平臺,

    可以把WebApi看成Asp.Net專案型別中的一種,其他專案型別諸如我們熟知的WebForm專案,Windows表單專案,控制臺應用程式等,

    WebApi型別專案的最大優勢就是,開發者再也不用擔心客戶端和服務器之間傳輸的資料的序列化和反序列化問題,因為WebApi是強型別的,可以自動進行序列化和反序列化,一會兒專案中會見到,

二.為什么要用 Web API

       Web API最重要的是可以構建面向各種客戶端的服務,另外與WCF REST Service不同在于,Web API利用Http協議的各個方面來表達服務(例如 URI/request response header/caching/versioning/content format),因此就省掉很多配置,

 當你遇到以下這些情況的時候,就可以考慮使用Web API了,

  • 需要Web Service但是不需要SOAP
  • 需要在已有的WCF服務基礎上建立non-soap-based http服務
  • 只想發布一些簡單的Http服務,不想使用相對復雜的WCF配置
  • 發布的服務可能會被帶寬受限的設備訪問
  • 希望使用開源框架,關鍵時候可以自己除錯或者自定義一下框架

三.Web API的主要功能

1. 支持基于Http verb (GET, POST, PUT, DELETE)的CRUD (create, retrieve, update, delete)操作

    通過不同的http動作表達不同的含義,這樣就不需要暴露多個API來支持這些基本操作,

2. 請求的回復通過Http Status Code表達不同含義,并且客戶端可以通過Accept header來與服務器協商格式,例如你希望服務器回傳JSON格式還是XML格式,

3. 請求的回復格式支持 JSON,XML,并且可以擴展添加其他格式,

4. 原生支持OData,

5. 支持Self-host或者IIS host,

6. 支持大多數MVC功能,例如Routing/Controller/Action Result/Filter/Model Builder/IOC Container/Dependency Injection,

四.Web API和WebService和WCF的區別

        Web Service

  1、它是基于SOAP協議的,資料格式是XML,

  2、只支持HTTP協議,

  3、它不是開源的,但可以被任意一個了解XML的人使用,

  4、它只能部署在IIS上,

  WCF

  1、這個也是基于SOAP的,資料格式是XML,

  2、這個是Web Service(ASMX)的進化版,可以支持各種各樣的協議,

       像TCP,HTTP,HTTPS,Named Pipes, MSMQ.,

  3、WCF的主要問題是,它配置起來特別的繁瑣,

  4、它不是開源的,但可以被任意一個了解XML的人使用,

  5、它可以部署應用程式中或者IIS上或者Windows服務中,

  WCF Rest

  1、想使用WCF Rest service,你必須在WCF中使用webHttpBindings,

  2、它分別用[WebGet]和[WebInvoke]屬性,實作了HTTP的GET和POST動詞,

  3、要想使用其他的HTTP動詞,你需要在IIS中做一些配置,使.svc檔案可以接受這些動詞的請求,

  4、使用WebGet通過引數傳輸資料,也需要配置,而且必須指定UriTemplate,

  5、它支持XML、JSON以及ATOM這些資料格式,

  Web API

  1、這是一個簡單的構建HTTP服務的新框架,

  2、在.net平臺上Web API 是一個開源的、理想的、構建REST-ful 服務的技術,

  3、不像WCF REST Service.它可以使用HTTP的全部特點(比如URIs、request/response頭,快取,版本控制,多種內容格式),

  4、它也支持MVC的特征,像路由、控制器、action、filter、模型系結、控制反轉(IOC)或依賴注入(DI),單元測驗,這些可以使程式更簡單、更健壯,

  5、它可以部署在應用程式和IIS上,

  6、這是一個輕量級的框架,并且對限制帶寬的設備,比如智能手機等支持的很好,

  7、Response可以被Web API的MediaTypeFormatter轉換成Json、XML 或者任何你想轉換的格式,

五.創建一個Asp.Net WebAPI專案

1.新建一個Asp.net空應用程式

 2.選擇WebAPI

 3.這里我們新增一個名為PersonControllerWeb Api2控制器

 

 

 3.在控制器中寫3個簡單的方法

 1     public class PersonController : ApiController
 2     {
 3         //不帶引數的方法
 4         public string[] Get()
 5         {
 6             return new string[] { "shuke", "beta", "tom" };
 7         }
 8         //根據學生ID查詢學生姓名
 9         public string Get(int id)
10         {
11             if (id == 1)
12             {
13                 return "shuke";
14             }
15             else
16             {
17                 return "beta";
18             }
19         }
20         //回傳學生姓名的長度
21         public int Get(string name)
22         {
23             return name.Length;
24         }
25     }

4.到這里一個簡單的Web API專案就創建完成了,點擊運行

 直接運行,不會直接跳轉到到我們寫的api里面,這里我們要將地址后面加上檔案地址加上這里指定的后綴(也可以改為別的),這里我的是api/Person/

 在瀏覽器地址加入后綴,當id=1是,可以看到這里結果為shuke,那么到這里就成功查詢出來了,

 5.除錯工具推薦:到這里基本一個webapi專案就完成了,剩下了就是顯示了,首先得先運行專案,然后再瀏覽器地址欄找到網址,然后復制到postman中,然后再呼叫相關的函式,我們在做大型專案是在瀏覽器除錯會有諸多不便,這里推薦一個常用的介面除錯工具Postman,

PostMan地址 :https://www.getpostman.com/

轉載請註明出處,本文鏈接:https://www.uj5u.com/net/1608.html

標籤:ASP.NET

上一篇:vue、element、axios、api 實作下載 excel 檔案

下一篇:.NET異步和多執行緒系列(四)- 多執行緒例外處理、執行緒取消、多執行緒的臨時變數問題、執行緒安全和鎖lock

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C#(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • WebAPI簡介

    Web體系結構: 有三個核心:資源(resource),URL(統一資源識別符號)和表示 他們的關系是這樣的:一個資源由一個URL進行標識,HTTP客戶端使用URL定位資源,表示是從資源回傳資料,媒體型別是資源回傳的資料格式。 接下來我們說下HTTP. HTTP協議的系統是一種無狀態的方式,使用請求/ ......

    uj5u.com 2020-09-09 22:07:47 more
  • asp.net core 3.1 入口:Program.cs中的Main函式

    本文分析Program.cs 中Main()函式中代碼的運行順序分析asp.net core程式的啟動,重點不是剖析原始碼,而是理清程式開始時執行的順序。到呼叫了哪些實體,哪些法方。asp.net core 3.1 的程式入口在專案Program.cs檔案里,如下。ususing System; us ......

    uj5u.com 2020-09-09 22:07:49 more
  • asp.net網站作為websocket服務端的應用該如何寫

    最近被websocket的一個問題困擾了很久,有一個需求是在web網站中搭建websocket服務。客戶端通過網頁與服務器建立連接,然后服務器根據ip給客戶端網頁發送資訊。 其實,這個需求并不難,只是剛開始對websocket的內容不太了解。上網搜索了一下,有通過asp.net core 實作的、有 ......

    uj5u.com 2020-09-09 22:08:02 more
  • ASP.NET 開源匯入匯出庫Magicodes.IE Docker中使用

    Magicodes.IE在Docker中使用 更新歷史 2019.02.13 【Nuget】版本更新到2.0.2 【匯入】修復單列匯入的Bug,單元測驗“OneColumnImporter_Test”。問題見(https://github.com/dotnetcore/Magicodes.IE/is ......

    uj5u.com 2020-09-09 22:08:05 more
  • 在webform中使用ajax

    如果你用過Asp.net webform, 說明你也算是.NET 開發的老兵了。WEBform應該是2011 2013左右,當時還用visual studio 2005、 visual studio 2008。后來基本都用的是MVC。 如果是新開發的專案,估計沒人會用webform技術。但是有些舊版 ......

    uj5u.com 2020-09-09 22:08:50 more
  • iis添加asp.net網站,訪問提示:由于擴展配置問題而無法提供您請求的

    今天在iis服務器配置asp.net網站,遇到一個問題,記錄一下: 問題:由于擴展配置問題而無法提供您請求的頁面。如果該頁面是腳本,請添加處理程式。如果應下載檔案,請添加 MIME 映射。 WindowServer2012服務器,添加角色安裝完.netframework和iis之后,運行aspx頁面 ......

    uj5u.com 2020-09-09 22:10:00 more
  • WebAPI-處理架構

    帶著問題去思考,大家好! 問題1:HTTP請求和回傳相應的HTTP回應資訊之間發生了什么? 1:首先是最底層,托管層,位于WebAPI和底層HTTP堆疊之間 2:其次是 訊息處理程式管道層,這里比如日志和快取。OWIN的參考是將訊息處理程式管道的一些功能下移到堆疊下端的OWIN中間件了。 3:控制器處理 ......

    uj5u.com 2020-09-09 22:11:13 more
  • 微信門戶開發框架-使用指導說明書

    微信門戶應用管理系統,采用基于 MVC + Bootstrap + Ajax + Enterprise Library的技術路線,界面層采用Boostrap + Metronic組合的前端框架,資料訪問層支持Oracle、SQLServer、MySQL、PostgreSQL等資料庫。框架以MVC5,... ......

    uj5u.com 2020-09-09 22:15:18 more
  • WebAPI-HTTP編程模型

    帶著問題去思考,大家好!它是什么?它包含什么?它能干什么? 訊息 HTTP編程模型的核心就是訊息抽象,表示為:HttPRequestMessage,HttpResponseMessage.用于客戶端和服務端之間交換請求和回應訊息。 HttpMethod類包含了一組靜態屬性: private stat ......

    uj5u.com 2020-09-09 22:15:23 more
  • 部署WebApi隨筆

    一、跨域 NuGet參考Microsoft.AspNet.WebApi.Cors WebApiConfig.cs中配置: // Web API 配置和服務 config.EnableCors(new EnableCorsAttribute("*", "*", "*")); 二、清除默認回傳XML格式 ......

    uj5u.com 2020-09-09 22:15:48 more
最新发布
  • C#多執行緒學習(二) 如何操縱一個執行緒

    <a href="https://www.cnblogs.com/x-zhi/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2943582/20220801082530.png" alt="" /></...

    uj5u.com 2023-04-19 09:17:20 more
  • C#多執行緒學習(二) 如何操縱一個執行緒

    C#多執行緒學習(二) 如何操縱一個執行緒 執行緒學習第一篇:C#多執行緒學習(一) 多執行緒的相關概念 下面我們就動手來創建一個執行緒,使用Thread類創建執行緒時,只需提供執行緒入口即可。(執行緒入口使程式知道該讓這個執行緒干什么事) 在C#中,執行緒入口是通過ThreadStart代理(delegate)來提供的 ......

    uj5u.com 2023-04-19 09:16:49 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    <a href="https://www.cnblogs.com/huangxincheng/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/214741/20200614104537.png" alt="" /&g...

    uj5u.com 2023-04-18 08:39:04 more
  • 記一次 .NET某醫療器械清洗系統 卡死分析

    一:背景 1. 講故事 前段時間協助訓練營里的一位朋友分析了一個程式卡死的問題,回過頭來看這個案例比較經典,這篇稍微整理一下供后來者少踩坑吧。 二:WinDbg 分析 1. 為什么會卡死 因為是表單程式,理所當然就是看主執行緒此時正在做什么? 可以用 ~0s ; k 看一下便知。 0:000> k # ......

    uj5u.com 2023-04-18 08:33:10 more
  • SignalR, No Connection with that ID,IIS

    <a href="https://www.cnblogs.com/smartstar/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/u36196.jpg" alt="" /></a>...

    uj5u.com 2023-03-30 17:21:52 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:15:33 more
  • 一次對pool的誤用導致的.net頻繁gc的診斷分析

    <a href="https://www.cnblogs.com/dotnet-diagnostic/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/3115652/20230225090434.png" alt=""...

    uj5u.com 2023-03-28 10:13:31 more
  • C#遍歷指定檔案夾中所有檔案的3種方法

    <a href="https://www.cnblogs.com/xbhp/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/957602/20230310105611.png" alt="" /></a&...

    uj5u.com 2023-03-27 14:46:55 more
  • C#/VB.NET:如何將PDF轉為PDF/A

    <a href="https://www.cnblogs.com/Carina-baby/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/2859233/20220427162558.png" alt="" />...

    uj5u.com 2023-03-27 14:46:35 more
  • 武裝你的WEBAPI-OData聚合查詢

    <a href="https://www.cnblogs.com/podolski/" target="_blank"><img width="48" height="48" class="pfs" src="https://pic.cnblogs.com/face/616093/20140323000327.png" alt="" /><...

    uj5u.com 2023-03-27 14:46:16 more