聊聊asp.net中Web Api的使用(实用博客)以及API接口的参数传递

转载地址https://www.cnblogs.com/vipstone/p/5632594.html
API接口的POST参数传递—比较好的介绍了几种常用Http Post参数传递方法
扯淡
随着app应用的崛起，后端服务开发的也越来越多，除了很多优秀的nodejs框架之外，微软当然也会在这个方面提供更便捷的开发方式。这是微软一贯的作风，如果从开发的便捷性来说的话微软是当之无愧的老大哥，只是鱼和熊掌不能兼得，各种语法糖带来开发的便利势必会牺牲程序运行的性能，这是无可避免的，通用和效率永远是需要程序员去取舍的话题。扯淡到这就完了，下来就聊聊今天的主角web api，web api 是mvc4.0之后出现的一种技术吧，他的创建和带来的便利我就不介绍了。这边文章主要聊聊，我对web api开发的一些理解。

话题一：[FromBody]特性修饰符
FromBody是一个修饰参数的特性，比如：public void Post([FromBody]string name)，那么他的作用是什么呢，其实他的作用是查询post请求中参数为name的值。

要注意的是：[FromBody]只能修饰单个参数，如果是多个参数的话，就要封装成对象进行数据专递了，比如：public void Post([FromBody]string name，[FromBody]int id)是取不到值的，要把id和name封装成Userinfo对象，使用 public void Post([FromBody]Userinfo user)进行调用。

话题二：post传递多个不同对象的参数
已经post请求需要使用[FromBody]特性修饰符接收，但是FromBody只能接收单个参数，如果需要传递不同对象的输出就比较麻烦了，新建实体对象成本太大，也不能完全适应适应的类型，这个时候需要使用JObject来处理，代码如下：

jQuery.post("/Api/Userinfo/Add/", {
    mobile: "18049579804",
    pwd: "123456",
    smsCode: "12346",
    t: new Date().getTime()
}, function (data) {
    if (data) {
        document.writeln(data);
    }
});

public string Add([FromBody]JObject pdata)
{
    string mobile = Convert.ToString(pdata["smsCode"]);
    string pwd = Convert.ToString(pdata["pwd"]);
    string smsCode = Convert.ToString(pdata["smsCode"]);
}

话题三：请求方式（Get & Post）
关键字区分：Get请求或者Post请求，可以用自身的关键字来区分，比如：GetUser(int id)肯定为get请求，Getxxx(params param)等格式为Get请求，post同理。当然还有一种方式，是没有关键字修饰的方法，比如：FindUser这种情况下，这种请求下默认是Post请求的Get请求就会报405的错。

话题四：返回json格式的结果
这个会简单设置返回值为Net自带的Json格式即可，可以返回JObject或JArray都是可以用ajax接收json对象的。代码如下：

public JObject PostFindUser([FromBody]Userinfo user)
{
    JObject res = new JObject();
    res["name"] = string.Format("{0}是好人~", user.Name);
    return res;
}

话题五：路由设置
本身的路由不是很好，需要设置WebApiConfig.cs配置为：控制/动作/参数

config.Routes.MapHttpRoute(
    name: "DefaultApi",
    routeTemplate: "api/{controller}/{Action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

题外话：webapi获取http header信息代码：Request.Headers.GetValues(“xxx”)