Web API是需要接受参数的,譬如,通常用于创建数据的POST method需要接受输入数据,而用于GET method也需要接受一些可选参数,譬如:为了性能起见,控制返回数据的数量是至关重要的。
首先来看输入参数的几种形式:
- /api1/{parameter1}/{parameter2}/…/{parametern}
- /api1&{parameter1}=xxx&{parameter2}=xxx&…&{parametern}=xxx
- /api1: 输入内容在Body中
有了以上理解,再来看ASP.NET Core 1.0如何实现。
- 针对第一种输入参数,实现方法是在对应的Controller中添加如下的属性
[Route("api/[controller]")]
public class ValueController : Controller
{
[HttpGet("{parameter1}\{parameter2}")]
public IEnumerable<String> Get(String parameter1, String parameter2)
{
// Do the job!
}
...
}
- 针对第二种输入参数(其实是可选参数),实现方法类似,只是不需要再HttpGet的属性中指定Route:
[Route("api/[controller]")]
public class ValueController : Controller
{
[HttpGet()]
public IEnumerable<String> Get(Int32? parameter1 = null, String parameter2 = "")
{
// Do the job!
}
...
}
- 针对第三种输入参数,实现方法是通过FromBody的属性:
[Route("api/[controller]")]
public class ValueController : Controller
{
[HttpPost]
public IActionResult Post([FromBody]String cont)
{
// Do the job!
}
...
}
既然提到了FromBody属性,那么索性介绍一下另外一个FromUri。以下示例来自于ASP.NET官方文档。
一个简单的FromUri使用场景:
public class GeoPoint
{
public double Latitude { get; set; }
public double Longitude { get; set; }
}
public ValuesController : ApiController
{
public HttpResponseMessage Get([FromUri] GeoPoint location) { ... }
}
是为之记。
Alva Chien
2016.6.24