一、課程介紹

一、王小二和他領導的第一次故事

有一天王小二和往常一下去上早班，剛吃完早餐剛一打開電腦沒一會兒。王小二的領導宋大寶走到他的面前，我們現在的系統需要提供服務給其他內部業務系統，我看你平時喜歡研究一些技術，所以這次這個任務有你來負責開發，務必保證我們項目組提供的服務好看、好用，最後順利的完成工作並上線運行。王小二頓到感覺無與倫比的器重和自豪感，於是晚上回家擼起鍵盤就是一頓baidu+google搜索，最後驚奇地發現了一本叫《ASP.NET WebAPI構建API接口服務實戰演練》葵花寶典。於是乎王小二開啟了習武之路。

1.1、本葵花寶典手冊適合學習人群如下：

1)、完全對ASP.NET WebAPI零基礎的童鞋們。

2)、進一步想學習和了解ASP.NET WebAPI技術。

3)、工作中如何快速通過ASP.NET WebAPI構建API接口服務。

4)、阿笨手把手的教會你如何寫一手漂亮的WebAPI接口文檔。

1.2、本葵花寶典手冊課程包含知識點如下：

1)、與Web API的第一次親密接觸，"奇葩"的默認路由配置

2)、 WebApi輸出格式有點"醜"，選擇XML和JSON哪一個格式？

3)、Web API "奇葩"的參數傳遞,看著一招就夠了。

4)、ASP.NET WebApi標準格式化統一輸出響應報文數據 。

5)、ASP.NET WebApi標準格式化統一輸出異常報文數據 。

6)、ASP.NET WebApi降龍十八掌之美化JSON時間類型T問題和CORS跨域訪問 。

7)、如何用markdown編寫一手漂亮的接口文檔。

1.3、一言以蔽之修煉完成本葵花寶典手冊後達到的境界？

我們如何優雅使用ASP.NET WebAPI構建API接口服務。

如果您對本次分享課程感興趣的話，那麽請跟蹤阿笨一起學習吧。廢話不多說，直接上幹貨，我們不生產幹貨，我們只是幹貨的搬運工。

二、手把手教會用ASP.NET WebAPI構建API接口服務

2.1、與Web API的第一次親密接觸，"奇葩"的默認路由配置

王小二剛興致勃勃打開葵花寶典手冊，一上來就遇到404訪問不了情況。聽說阿笨有解決辦法，我去問問題他吧！

ASP.NET Web API路由是整個API的入口。我們訪問某個資源就是通過路由映射找到對應資源的URL。通過URL來獲取資源的。

對於ASP.NET Web API內部實現來講，我們的請求最終將定位到一個具體的Action上。所以說，ASP.NET Web API路由就是把客戶端請求映射到對應的Action上的過程。

2.2、 WebApi輸出格式有點"醜"，選擇XML和JSON哪一個格式？

王小二好不容易把404的問題解決了，卻遇到了XML和JSON生成出來的有點“醜”的樣子，簡直就是四不像啊！聽說阿笨有解決辦法，我去問問題他吧！

2.3、Web API "奇葩"的參數傳遞,看著一招就夠了

王小二好不容易把輸出格式四不像問題解決了，但是在使用POST多傳遞幾個參數的情況下，就要註意[FromUri] ,[FromBody]帶來的限制 ，太復雜了，能不能簡單一點。只好問阿笨該如何解決了！聽說阿笨有解決辦法，我去問問題他吧！

ASP.NET Web API參數傳遞把握一個思想，不管多麽復雜的參數，都采用扁平化來設計。

2.4、ASP.NET WebApi標準格式化統一輸出響應報文數據

王小二總算咬牙堅持邁過了上面的那麽多“坑”，頓時興奮不已。剛準備關機睡覺的時候，總感覺心裏有事情沒解決，頓時坐了起，調用方怎麽知道我給的接口數據結果就執行成功和失敗了啊。不可能用空字符串來判斷吧。聽說阿笨有解決辦法，我去問問題他吧！

2.5、ASP.NET WebApi標準格式化統一輸出異常報文數據

王小二總算解決了標準格式化統一輸出響應報文數據，正興高采烈的調試第一個接口的時候，卻出現了Exception這個程序員惡魔，只好無奈的看著屏幕前一堆紅色的錯誤輸出頁面。正在焦頭爛額的時候，想到了阿笨。聽說阿笨有解決辦法，我去問問題他吧！

2.6、ASP.NET WebApi降龍十八掌之美化JSON時間類型T問題和CORS跨域訪問

1）、解決json小寫問題。

2）、解決json格式化縮進問題。

3）、解決json時間帶T的問題。

4)、解決json序列化時的循環引用問題。

5）、解決支持啟用跨域訪問。

2.7、如何用markdown編寫一手漂亮的接口文檔

王小二現在已經可以擼一手漂亮的接口了，俗話說:人靠衣裝馬靠鞍！我們開發的接口是對外給調用方使用的，那麽我們如何編寫一手漂亮的接口文檔，讓調用方一看眼前一亮，賞心悅目的感覺咧。

API Manager是一個在線API文檔系統；其致力於快速解決團隊內部接口文檔的編寫、維護、存檔，和減少團隊協作開發的溝通成本。

三、總結

3.1、王小二和他領導的第二次故事

上一次宋大寶交給王小二的任務完成的非常滿意，還沒來得及當面表揚王小二這個小夥子，卻語重心長的說了一番話：隨著公司業務量的增長，我們的產品得到了外面商戶的一致好評，為了更好的與商戶進行業務往來，因此我們公司準備也要弄自己的服務平臺。我昨晚思考了一下給你簡單的說了一下大概對服務平臺的要求：不管客戶端是使用PHP、JAVA、C#、移動設備等等語言和設備都能與我們的服務平臺進行對接，並且維護和對接成本很低；將來我們需要針對不同的商戶進行流量管控，對了最好能過部署在Linux操作系統上，必須將來考慮移植的工作量。王小二我覺得你的能力很不錯，小夥子平時交付給你的事情都能夠讓我滿意，所以這個服務平臺就有你來主導並開發了，務必按時保質保量完成工作。

王小二倍再一次的感受到了內心的欣慰之情，但是這一次卻表情凝重，下班回到家仔細冷靜思考了一宿，於是第二個早上班的時候， 總結了以下幾點關於服務平臺的設計並匯報了宋大寶。

1 )、由於數據不能泄密和篡改，需要保證對外的服務接口可靠性和安全性。

2)、我們提供的服務對開發語言的兼容性強、可擴展性一定要好、最好將來能夠跨平臺。

從上面的故事，我們可以看的出來宋大寶領導對王小二的器重以及對服務平臺的重視！ 預知後事如何,請聽下回分解！

ASP.NET WebAPI構建API接口服務實戰演練