Postman访问Webapi的Get/Post/Put/Delte请求
问题场景:
ASP.NET MVC WebApi 定义Get/Post/Put/Delete方法。使用Postman工具调用相应的方法。根据方法的特性不同、参数的特性不同,所访问的方式也不同。
问题分析:
创建一个新的WebApi的项目。控制器自动生成的代码如下:
首先看到类的上面有个特性默认如下:
[Route("api/[controller]")]
这个是访问时的路由规则(eg:http://localhost:port/api/conroller)。访问地址时不需要输入方法名,路由规则会根据参数的情况自动匹配。
建议将路由规则修改为
[Route("api/[controller]/[action]")]
这样的话我们就能输入方法名精确到我们需要访问的方法。下面开始介绍Get/Post/Put/Delete请求。
1.页面访问Get请求方法:
以下为使用Postman时请求GET的简单说明:
a) 特性为HttpGet
[HttpGet]
public IEnumerable<string> Get()
{
return new string[] { "value1", "value2" };
}
Postman使用GET请求,Url地址即可(eg:http://localhost:port/api/values/Get),如果该方法有参数,则在Params输入对应的参数名和参数值即可(即url地址中尾部增加'?key1=val1&key2=val2')。得到的返回值是["value1","value2"]
b) 特性为HttpGet("{name}")
[HttpGet("{id}")]
public int Get(int id)
{
return id;
}
[HttpGet("{id}")]这个特性是自动生成的,具体的话没有深入的研究。请求的参数方式会有些不同。他所携带的参数请求规则为:
http://localhost:54261/api/values/Get/idvalue 。
2.页面访问POST请求方法:
a) 参数为基本数据类型
[HttpPost]
public string Post(string str)
{return str;
}
Headers框下方的"Content-Type" 所对应的值应为 "application/x-www-form-urlencoded"
然后在"Body"框下输入对应的参数名和参数值,点击"Send"按钮即可请求并且得到返回值。
b) 参数特性被标记为[FromBody]
[HttpPost]
public string Post([FromBody]string value)
{return value;
}
假若传递的参数类型的特性为[FromBody]时,需要注意:作为被标记为[FromBody]的参数只能出现一次,并且 [FromBody] 参数不能是基本的数据类型(如byte、int、bool、DateTime、string等)。
所以以上的方法是不能被访问到的。
c) [FromBody]标记的参数为对象
public class ReqTest
{
public int id { get; set; }
public string name { get; set; }
}[HttpPost]
public string Post([FromBody]ReqTest req)
{
return req.id.ToString() + req.name;
}
[FromBody]标记参数需要使用json的格式进行传递。
Headers框下方的"Content-Type" 所对应的值应为 "application/json"
然后在"Body"框下选择"raw",输入json格式的参数进行访问(eg:{"id":9527,"name":"Mark"})。
得到的返回值为"9527Mark"
3.HTTP PUT/Delete请求方式:
PUT请求和Delete请求实际用到的情况不是很多。使用方式跟POST差不多,只需要注意将Postman的请求方式改成对应的PUT或者Delete方式即可。