Web API 接口参数解析

• get请求(数据都会包括在url地址上)
• 基础类型参数的get请求

//web api示例
[HttpGet]
public string GetAllChargingData(int id,string name){
    return "Charging" + id + " " + name;
}

//AngularJS请求
$http.get("/GetAllChargingData?id=1&name=Jim").then(res => { }, () => { }) //Charging1 Jim
$http.get("/GetAllChargingData", {params: {id: 1,name: "aaaa"}}).then(res => { }, () => {})//Charging1 aaaa
//对于ajax
$.ajax({
    type: "get",
    url: "/GetAllChargingData",
    data: { id: 1,name: "Jim",bir: "1988-09-11" },
    success: function (data, status) { if (status == "success") { } }// Charging1 Jim
});

• 实体作为参数的get请求
• 对于第一个接口，直接将json对象当做实体传递给后台，后台无法接受到，所以AngularJS请求报错415，Ajax请求则是接受的null
• 对于第二个接口，在接口的参数加上[FromUri]特性(强制Web API从URL读取复杂类型)，这样AngularJS请求和Ajax请求都可以接受到数据
• 对于第三个接口，这是在页面请求上使用JSON.stringify()方法对json数据进行序列化，然后在接口中反序列化，URL地址上后面会加上一串编码

[HttpGet]//TB_CHARGING 是一个类
public JsonResult<TB_CHARGING> GetByModel(TB_CHARGING oData){
    return Json(oData);
}
[HttpGet]
public JsonResult<TB_CHARGING> GetByModelFromUri([FromUri]TB_CHARGING oData){
    return Json(oData);
}
[HttpGet]
public JsonResult<TB_CHARGING> GetByModelstring(string strQuery){
    TB_CHARGING oData = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(strQuery);//反序列化
    return Json(oData);
}

var data = {ID: "1",NAME: "Jim",DES: "aaaaa",CREATETIME: "1988-09-11"};
//AngularJS请求
$http.get("/GetByModel", { params: data }).then(res => {}, () => {})//415报错
$http.get("/GetByModelFromUri", { params: data }).then(res => {}, () => {})//正常返回数据
$http.get("/GetByModelstring", { params: { strQuery: JSON.stringify(data) }}).then(res => {}, () => {})//正常返回数据
//对于ajax
$.ajax({
    type: "get",
    url: "/GetByModel",
    contentType: "application/json",
    data: data,
    success: function (data, status) { if (status == "success") {} }//null
});
$.ajax({
    type: "get",
    url: "/GetByModelFromUri",
    contentType: "application/json",
    data: data,
    success: function (data, status) { if (status == "success") {} }//正常返回数据
});
$.ajax({
    type: "get",
    url: "/GetByModelstring",
    contentType: "application/json",
    data: { strQuery: JSON.stringify(data) },//序列化
    success: function (data, status) { if (status == "success") {} }//正常返回数据
});

• 数组作为参数
• 在Web API中，方法名以Get开头，Web API会自动默认为get请求，但是如果使用其他名称开头但是又不使用特性标记，可能在请求时报错405，所以所有的Web API接口都应该加上([HttpGet]/[HttpPost]/[HttpPut]/[HttpDelete])的特性
• post请求(参数放在请求体上)
• 基础类型参数
• 第一种接口，Ajax请求时无法传入参数，但是AngularJS可以请求成功
• 第二个接口加上[FromBody]特性(可以强制Web API从请求正文中读取简单类型)，且([FromBody]string NAME，[FromBody]string DES)这样是错误使用，应该使用第三种接口使用dynamic类型，对于第二种接口，AngularJS请求时无法传入参数，但是Ajax可以请求成功

[HttpPost]
public string SaveData_ng(string NAME){
    return NAME;
}
[HttpPost]
public string SaveData([FromBody]string NAME){
    return NAME;
}
[HttpPost]//推荐写法
public object SaveData_obj(dynamic obj){
    var strName = Convert.ToString(obj.NAME);
    return strName;
}

//AngularJS请求
$http.post("/SaveData_ng?NAME=jam", {}, {}).then(res => {}, () => {});//jam
$http.post("/SaveData_obj", { NAME: "Jim", DES: "备注" }, {}).then(res => {}, () => {});//Jim
//Ajax请求
$.ajax({
    type: "post",
    url: "/SaveData",
    data: { "": "JIM" },
    success: function (data, status) { if (status == "success") {} }//"JIM"
})
$.ajax({
    type: "post",
    url: "/SaveData_obj",
    contentType: 'application/json',//需要加上
    data: JSON.stringify({ NAME: "Jim", DES: "备注" }),
    success: function (data, status) { if (status == "success") {} }//"Jim"
})

• 实体类型参数

[HttpPost]
public TB_CHARGING SaveData_oData(TB_CHARGING oData){
    return oData;
}

var postdata = { ID: "1", NAME: "Jim", CREATETIME: "1988-09-11" };
//AngularJS请求
$http.post("/SaveData_oData", postdata, {}).then(res => { }, () => {});//返回实体参数
//Ajax请求
$.ajax({
    type: "post",
    url: "/SaveData_oData",
    data: postdata,//该写法的contentType默认为application/x-www-form-urlencoded 目前写法
    //还有一种写法 contentType: "application/json",  data: JSON.stringify(postdata),
    success: function (data, status) { if (status == "success") {} }//返回实体参数
})

• 实体类型和基础类型一起作为参数

[HttpPost]
public object SaveData_objs(dynamic obj){
    var strName = Convert.ToString(obj.NAME);
    var oCharging = Newtonsoft.Json.JsonConvert.DeserializeObject<TB_CHARGING>(Convert.ToString(obj.Charging));
    return strName;
}

 

//AngularJS请求
$http.post("/SaveData_objs", { NAME: "Lilei", Charging: postdata }, {}).then(res => { }, () => {});//Lilei 
//Ajax请求
$.ajax({
    type: "post",
    url: "/SaveData_objs",
    contentType: 'application/json',
    data: JSON.stringify({ NAME: "Lilei", Charging: postdata }),
    success: function (data, status) { if (status == "success") {} }//Lilei 
});

• 数组类型参数(基础类型的数组，实体集合)

[HttpPost]
public string[] SaveData_Array(string[] ids){
    return ids;
}       
[HttpPost]
public List<TB_CHARGING> SaveData_List(List<TB_CHARGING> lstCharging){
    return lstCharging;
}

var arr = ["1", "2", "3", "4"];
var list = [postdata,postdata,postdata]
//AngularJS请求
$http.post("/SaveData_Array", arr, {}).then(res => { }, () => {});//["1","2","3","4"] 
$http.post("/SaveData_List", list, {}).then(res => { }, () => {});//list集合
//Ajax请求
$.ajax({
    type: "post",
    url: "/SaveData_Array",
    contentType: 'application/json',
    data: JSON.stringify(arr),
    success: function (data, status) { if (status == "success") {} }//["1","2","3","4"]
});
$.ajax({
    type: "post",
    url: "/SaveData_List",
    contentType: 'application/json',
    data: JSON.stringify(list),
    success: function (data, status) { if (status == "success") {} }//list集合
});

• put请求和delete请求与post请求相似

public class TB_CHARGING{
    public string ID { get; set; }
    public string NAME { get; set; }
    public string DES { get; set; }
    public DateTime CREATETIME { get; set; }
}