0

我有一个控制器来获取一个资源（比如员工），它有两个属性（比如 CategoryId 和 DepartmentId）。我需要配置路由以支持以下 URL：

~/api/employees/1234 [to get the employee with employeeId=1234]
~/api/employees [to get all the employees]
~/api/employees?departmentid=1 [to get all the employees with departmentId=1]

控制器代码如下所示：

public IEnumerable<Employee> Get()
{
    ....
}

public IEnumerable<Employee> Get(int employeeId, int departmentId = -1, int categoryId = -1)
{
    .....
}

如何为此控制器配置路由？

谢谢

4

2 回答 2

0

对于任何 querystyring 参数，在路由方面没有什么可做的：只需让控制器方法参数与 qs 参数名称匹配（不区分大小写。）

相反，如果您的方法参数引用的是 uri 段，则方法参数名称必须与大括号之间的路由参数/段匹配

routes.MapHttpRoute(
    name: "API Default",
    routeTemplate: "/api/{controller}/{employeeId}",
    defaults: new { id = RouteParameter.Optional }
);

这意味着您需要一个具有以下方法的控制器

public class EmployeesController : ApiController
{
public IEnumerable<Employee> Get(int employeeId){...} 
}

请记住，除非您使用操作，否则在您的控制器上，每个 http 动词只能使用一种方法。
换句话说，除非您对它们都使用显式操作，否则您的样本对于动词 get 有 2 种方法将不起作用。

于 2013-09-25T09:23:56.297 回答
0

你看过使用属性路由吗？我们现在广泛使用属性路由，以至于我们完全摆脱了使用 MapHttpRoute 的默认 /controller/action 类型路由。

相反，我们如下装饰我们的控制器。首先，我们为控制器创建一个路由前缀，以便我们知道我们需要的基本路由是什么

/// <summary>   A controller for handling products. </summary>
[RoutePrefix("api/purchasing/locations/{locationid}/products")]
public class ProductsController : PurchasingController
{

然后对于控制器中的每个动作，我们将其装饰如下：

    [Route("", Name = "GetAllProducts")]
    public IHttpActionResult GetAllProducts(int locationid, ODataQueryOptions<FourthPurchasingAPI.Models.Product> queryOptions)
    {
        IList<Product> products = this.GetProducts(locationid);

和

    [Route("{productid}", Name = "GetProductById")]
    public IHttpActionResult GetProduct(int locationid, string productid)
    {
        Product product = this.GetProductByID(locationid, productid);

所以对api/purchasing/locations/1/products/的调用将解析为名为“GetAllProducts”的路由，对api/purchasing/locations/1/products/1的调用 将解析为名为“GetProductById”的路由

然后，您可以在控制器中创建另一个具有相同签名的 GetProduct 操作，只需适当地设置属性路由，例如

    [Route("/department/{departmentId}", Name = "GetAllProductsForDepartment")]
    public IHttpActionResult GetAllProductsWithDeptId(int locationid, int departmentId)
    {
        IList<Product> products = this.GetProducts(locationid, departmentId);

现在调用 api/purchasing/locations/1/products/department/1234将解析到名为“GetAllProductsForDepartment”的路由

我知道这个示例使用的是 Web Api 2，但请查看此链接以获取 Web Api 中的属性路由。它应该完全相同，而不是您将返回 IHttpActionResult 以外的其他内容。

于 2014-10-23T15:49:51.073 回答