美化WebApi,使其統一返回Json格式

2021-09-25 20:37:43 字數 1700 閱讀 2519

部落格部分**來自其他博主,暫時找不到你的博文連線,如果您覺得我的**中引入了您的**或者文章,可在下方把您的部落格文章寫在下面,謝謝!!!

webapi有兩種返回資料格式,一種是xml,一種是json,在webapi中,你可以選擇你自己喜歡的返回資料格式,在這裡,我基本都是返回的是json,基本上,使用webapi 的時候,我都設定的是返回json,我們美化介面,乃知全域性,都將以json格式顯示出來!

這是 api 預設返回的xml格式,我們接下來美化一下!

一:新建乙個空的webapi專案

建立乙個資料夾 ,我這裡  我這裡取名字為:intefilter

建立乙個類  jsoncontentnegotiator  ,繼承  icontentnegotiator

需要引入這三個命名空間

二  建立 underlinesplitcontractresolver 類  繼承 defaultcontractresolver  (需要引入 using newtonsoft.json.serialization;)

1

namespace

demoapi.intefilter210

11private

string camelcasetounderlinesplit(string

name)

1231}32

}33else

3437}38

}39.tolower(ch));41}

4243

return

builder.tostring();44}

454647}

48 }

三  開啟webapiconfig

引入 

using system.net.http.formatting;

///

///

///

public

static

class

webapiconfig

//",

defaults:

new );}

}

結果:

統一返回格式

首先是乙個統一返回格式的主類 data noargsconstructor allargsconstructor public class apiresult public apiresult apienum apienum public apiresult string msg 然後是運用列舉定義...

json統一返回格式

一般我們會使用這樣的封裝 public class result但是這樣封裝的壞處 1.使用不方便 每次都需要new 我們呼叫者只關心成功時返回什麼資料,失敗時code及msg 2.不能保證code和msg統一 多人協同開發時 針對第一條我們改進為 public class result 針對第二條...

Web API系列 三 統一異常處理

前面講了webapi的安全驗證和引數安全,不清楚的朋友,可以看看前面的文章,web api系列 二 介面安全和引數校驗 本文主要介紹web api異常結果的處理。作為內部或者是對外提供的統一webapi 介面,統一的異常處理,把正確的資訊返回給呼叫者很重要。這樣可以讓介面開發人員,了解具體的原因所在...