如何在 MVC 中使用/配置路由

Question

当它被称为 /api/Games/aaa 时，我希望运行方法 Get(string deviceId = "")。但是当它被称为 api/Games/GameById/TaskId 我希望方法 GameById(int id) 被运行。但它不起作用，尤其是第二种方法。

控制器：

public class GamesController : ApiController
    {
        private List<Game> _gamesRepository;


        public GamesController()
        {
            _gamesRepository = CreateGamesRepository();
        }



        // GET api/Games/DeviceId
        [HttpGet]
        public IEnumerable<Game> Get(string deviceId = "")
        {
            IEnumerable<Game> result;

            if (String.IsNullOrEmpty(deviceId))
            {
                result = _gamesRepository.AsEnumerable();
            }
            else
            {
                result = _gamesRepository.Where(x => x.DeviceId == deviceId).AsEnumerable();
            }
            return result;

        }


        // GET api/Games/GameById/Id
        [HttpGet]
        public IEnumerable<Game> GameById(int id)
        {
            IEnumerable<Game> result;

            result = _gamesRepository.Where(x => x.TaskId == id).AsEnumerable();

            return result;

        }

路由：

 public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            routes.MapRoute(
            name: "GamesRoute",
            url: "api/{controller}/{deviceId}",
            defaults: new { controller = "controller", action = "get", deviceId = UrlParameter.Optional }
        );

            routes.MapRoute(
           name: "GamesRoute2",
           url: "api/games/GameById/{id}",
                // defaults: new { id = UrlParameter.Optional }
                defaults: new { controller = "games", action = "GameById" },
                constraints: new { id = @"\d+" }
       );

型号：

   public class Game
    {
        public int TaskId { get; set; }
        public string SalesForceId { get; set; }
        public string Name { get; set; }
        public string Thumbnail { get; set; }
        public string DeviceId { get; set; }
    }
}

Answer 1

您可以尝试将 RouteParameters 设置为可选吗？

defaults: new { id = RouteParameter.Optional }

Answer 2

地图路线的顺序很重要，因为匹配的第一条路线获胜，并且框架停止寻找更多路线。

一般路线应该添加在更具体的路线之后。

public static class WebApiConfig {

    public static void Register(HttpConfiguration config) {

         config.Routes.MapRoute(
           name: "GamesRoute2",
           routeTemplate: "api/games/GameById/{id}",
           defaults: new { controller = "games", action = "GameById" },
           constraints: new { id = @"\d+" }
        );

        config.Routes.MapRoute(
            name: "GamesRoute",
            routeTemplate: "api/{controller}/{deviceId}",
            defaults: new { controller = "controller", action = "get", deviceId = UrlParameter.Optional }

        );
     }
}

Answer 3

我个人认为您不需要映射 Web API 配置中的每条路由。使用可持续的架构并支持您想要使用的设计类型。

在您的情况下，我会通过在 WebApiConfig 中使用此配置来为我的 API 使用更具描述性的 URI：

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

它的作用是允许您在 URI 中指定 /action，这样您就可以在调用中非常明确。然后您的端点将变为：

/api/games/getById?id=1
/api/games/get?"Test"

编辑

如果您希望路由与 api/games/{parameter} 完全匹配，那么我会在该方法上添加一个 Route 属性，如下所示：

[Route("api/games/{id}")]
public IEnumerable<Game> Get(string deviceId = "")

希望这会有所帮助。