關于Lind.DDD.Api的使用與客戶端的調用
作者:張占嶺
花名:倉儲大叔
框架:Lind.DDD,Lind.DDD.Api
目錄
Api里注冊全局校驗特性 1
Api中設置全局的Cors跨域資源訪問 2
Api直接返回Json,而不是Xml 2
Api中Controller的Get,Post,Put和Delete 3
Api中Controller幾大方法重載要注意的 3
客戶端如何調用Api 4
對ResponseMessage的結果按需返回 5
對ResponseMessage添加TotalRecords支持分頁集合 6
客戶端如何為服務端傳輸加密密鑰 7
Api里注冊全局校驗特性
Api中設置全局的Cors跨域資源訪問
Api直接返回Json,而不是Xml
添加全局過濾器之后,再訪問API之后就被響應成JSON串了
Api中Controller的Get,Post,Put和Delete
Get:一般用于讀取資源
Post:用來添加資源
Put:用來更新資源
Delete:用于刪除資源
Api中Controller幾大方法重載要注意的
一、方法類型相同,名稱不同,個數相同,這種重載不被允許
二、方法類型不同,個數相同,這種重載可以
三、方法類型不同,個數相同,但名稱相同,這種重載不可以
客戶端如何調用Api
讀取資源
添加資源
更新資源:
對ResponseMessage的結果按需返回
對于一個對象,一個集合,它在返回到客戶端時可能有些信息是無用的,如果把他們返回那就是多余的,造成了不必要的數據傳輸的損失,所以我們應該按需序列化字段,而不是把方法所有字段都返回到客戶端,而返回的字段列表,由客戶端的請求參數決定。
對于ReturnMessage的返回,需要指定要過濾的字段,這些返回到客戶端就只有指定的字段了,需要注意的是,我們的每個字段之間需要用逗號分割,這是一個約定。
對ResponseMessage添加TotalRecords支持分頁集合
如果分頁返回的數據,我們在前臺需要知道集合的所有數量,然后和當前頁碼及每頁顯示的數據量來構建我們的模塊。
在Body的set塊中為TotalRecords屬性賦值
然后ReturnMessaged在序列化后,將TotalRecords響應到客戶端。
客戶端如何為服務端傳輸加密密鑰
Lind.DDD框架里為我們提供了簡單的方式進行密鑰串的長成,你只需要將參數到到NameValueCollection鍵值對里,然后調用密鑰生產方法,最后使用它自己的擴展方法ToUrl()來進行最終地址的升成。
驗證成功,返回如下結果
當驗證不合法時,則返回如下結果
而服務端可以通過全局的過濾器對URL地址進行解析,并校驗它的合法性!
好了,本講主要是一些基礎知識的介紹,我們在使用webApi開發項目過程中,還會不斷的總結。
文章列表