Question

我正在从WCF Web API转换为新的ASP.NET MVC 4 Web API。我有一个UsersController，我想要一个名为Authenticate的方法。我看到了如何进行GetAll，GetOne，Post和Delete的示例，但是如果我想在这些服务中添加额外的方法呢？例如，我的UsersService应该有一个名为Authenticate的方法，它会传入用户名和密码，但是它不起作用。

public class UsersController : BaseApiController
{
    public string GetAll()
    {
        return "getall!";
    }

    public string Get(int id)
    {
        return "get 1! " + id;
    }

    public User GetAuthenticate(string userName, string password, string applicationName)
    {
        LogWriter.Write(String.Format("Received authenticate request for username {0} and password {1} and application {2}",
            userName, password, applicationName));

        //check if valid leapfrog login.
        var decodedUsername = userName.Replace("%40", "@");
        var encodedPassword = password.Length > 0 ? Utility.HashString(password) : String.Empty;
        var leapFrogUsers = LeapFrogUserData.FindAll(decodedUsername, encodedPassword);

        if (leapFrogUsers.Count > 0)
        {
            return new User
            {
                Id = (uint)leapFrogUsers[0].Id,
                Guid = leapFrogUsers[0].Guid
            };
        }
        else
            throw new HttpResponseException("Invalid login credentials");
    }
}

我可以浏览myapi / api / users /它会调用GetAll，我可以浏览到myapi / api / users / 1，它会调用Get，但是如果我调用myapi / api / users / authenticate？username = {0}＆amp; password = {1}然后它将调用Get（NOT Authenticate）和错误：

参数字典包含非可空类型'System.Int32'的参数'id'的空条目，用于'Navtrak.Services.WCF.NavtrakAPI.Controllers.UsersController'中的方法'System.String Get（Int32）' 。可选参数必须是引用类型，可空类型，或者声明为可选参数。

如何调用自定义方法名称，例如Authenticate？

Answer 1

默认情况下，路由配置遵循RESTFul约定，这意味着它只接受Get，Post，Put和Delete操作名称（在global.asax =＆gt;中查看路由，默认情况下它不允许你指定任何动作名称=＆gt;它使用HTTP动词来分派）。因此，当您向/api/users/authenticate发送GET请求时，您基本上会调用Get(int id)操作并传递id=authenticate，这显然会崩溃，因为您的Get操作需要一个整数。

如果您想拥有与标准动作名称不同的动作名称，可以在global.asax中修改路线定义：

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

现在，您可以导航到/api/values/getauthenticate以验证用户身份。

Answer 2

这是迄今为止我提出的最佳方法，即在支持常规REST方法的同时引入额外的GET方法。将以下路由添加到WebApiConfig：

routes.MapHttpRoute("DefaultApiWithId", "Api/{controller}/{id}", new { id = RouteParameter.Optional }, new { id = @"\d+" });
routes.MapHttpRoute("DefaultApiWithAction", "Api/{controller}/{action}");
routes.MapHttpRoute("DefaultApiGet", "Api/{controller}", new { action = "Get" }, new { httpMethod = new HttpMethodConstraint(HttpMethod.Get) });
routes.MapHttpRoute("DefaultApiPost", "Api/{controller}", new {action = "Post"}, new {httpMethod = new HttpMethodConstraint(HttpMethod.Post)});

我使用下面的测试类验证了此解决方案。我能够在下面的控制器中成功点击每个方法：

public class TestController : ApiController
{
    public string Get()
    {
        return string.Empty;
    }

    public string Get(int id)
    {
        return string.Empty;
    }

    public string GetAll()
    {
        return string.Empty;
    }

    public void Post([FromBody]string value)
    {
    }

    public void Put(int id, [FromBody]string value)
    {
    }

    public void Delete(int id)
    {
    }
}

我确认它支持以下请求：

GET /Test
GET /Test/1
GET /Test/GetAll
POST /Test
PUT /Test/1
DELETE /Test/1

注意如果您的额外GET操作不以“Get”开头，您可能需要在方法中添加HttpGet属性。

Answer 3

我进入了MVC4世界。

为了它的价值，我有一个SitesAPIController，我需要一个自定义方法，可以这样调用：

http://localhost:9000/api/SitesAPI/Disposition/0

使用不同的值来获取具有不同处置的最后一个参数。

最后为我工作的是：

SitesAPIController中的方法：

// GET api/SitesAPI/Disposition/1
[ActionName("Disposition")]
[HttpGet]
public Site Disposition(int disposition)
{
    Site site = db.Sites.Where(s => s.Disposition == disposition).First();
    return site;
}

这是在WebApiConfig.cs

中

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

// this i added
config.Routes.MapHttpRoute(
    name: "Action",
    routeTemplate: "api/{controller}/{action}/{disposition}"
 );

只要我将{disposition}命名为{id}我遇到了：

{
"Message": "No HTTP resource was found that matches the request URI 'http://localhost:9000/api/SitesAPI/Disposition/0'.",
"MessageDetail": "No action was found on the controller 'SitesAPI' that matches the request."
}

当我将其重命名为{disposition}时，它开始工作了。显然，参数名称与占位符中的值匹配。

随意编辑此答案，使其更准确/更具说明性。

Answer 4

默认情况下，Web Api需要api / {controller} / {id}形式的URL来覆盖此默认路由。您可以使用以下两种方式之一设置路由。

第一个选项：

在WebApiConfig.cs中添加以下路线注册

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

使用HttpGet和参数装饰你的动作方法，如下所示

[HttpGet]
public HttpResponseMessage ReadMyData(string param1,
                        string param2, string param3)

 {

// your code here

}

用于调用上面的方法url将如下所示

http://localhost:[yourport]/api/MyData/ReadMyData?param1=value1&param2=value2&param3=value3

第二个选项 将路由前缀添加到Controller类并使用HttpGet装饰您的操作方法，如下所示。在这种情况下，无需更改任何WebApiConfig.cs。它可以有默认路由。

[RoutePrefix("api/{controller}/{action}")]
public class MyDataController : ApiController
{

[HttpGet]
public HttpResponseMessage ReadMyData(string param1,
                        string param2, string param3)

{

// your code here

}

}

用于调用上面的方法url将如下所示

http://localhost:[yourport]/api/MyData/ReadMyData?param1=value1&param2=value2&param3=value3

Answer 5

有关命名操作的详细讨论，请参阅此文章。它还表明您可以使用[HttpGet]属性，而不是使用＆＃34; get＆＃34;前缀动作名称。

http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-in-aspnet-web-api

Answer 6

如果您将 ASP.NET 5 与 ASP.NET MVC 6 一起使用，大多数答案根本不起作用，因为您通常会让MVC为您创建适当的路由集合（使用默认的RESTful约定），这意味着您将无法随意查找任何Routes.MapRoute()调用。

ConfigureServices()文件调用的Startup.cs方法将使用内置于ASP.NET 5中的依赖注入框架注册MVC：这样，当您稍后在该类中调用ApplicationBuilder.UseMvc()时， MVC框架会自动将这些默认路由添加到您的应用程序。我们可以通过查看框架源代码中的UseMvc()方法实现来了解幕后发生的事情：

public static IApplicationBuilder UseMvc(
    [NotNull] this IApplicationBuilder app,
    [NotNull] Action<IRouteBuilder> configureRoutes)
{
    // Verify if AddMvc was done before calling UseMvc
    // We use the MvcMarkerService to make sure if all the services were added.
    MvcServicesHelper.ThrowIfMvcNotRegistered(app.ApplicationServices);

    var routes = new RouteBuilder
    {
        DefaultHandler = new MvcRouteHandler(),
        ServiceProvider = app.ApplicationServices
    };

    configureRoutes(routes);

    // Adding the attribute route comes after running the user-code because
    // we want to respect any changes to the DefaultHandler.
    routes.Routes.Insert(0, AttributeRouting.CreateAttributeMegaRoute(
        routes.DefaultHandler,
        app.ApplicationServices));

    return app.UseRouter(routes.Build());
}

关于这一点的好处是框架现在可以处理所有的艰苦工作，遍历所有Controller的操作并设置其默认路由，从而为您节省多余的工作。

糟糕的是，关于如何添加自己的路线的文档很少或根本没有。幸运的是，您可以使用基于约定的和/或基于属性的方法（也称为属性路由）轻松实现此目的。

<强>公约基于

在Startup.cs类中，替换为：

app.UseMvc();

用这个：

app.UseMvc(routes =>
            {
                // Route Sample A
                routes.MapRoute(
                    name: "RouteSampleA",
                    template: "MyOwnGet",
                    defaults: new { controller = "Items", action = "Get" }
                );
                // Route Sample B
                routes.MapRoute(
                    name: "RouteSampleB",
                    template: "MyOwnPost",
                    defaults: new { controller = "Items", action = "Post" }
                );
            });

<强>基于属性的

关于MVC6的一个好处是，您还可以通过使用适当的Controller和Action类和/或RouteAttribute方法来定义每个控制器的路由。 /或HttpGet / HttpPost模板参数，例如：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNet.Mvc;

namespace MyNamespace.Controllers
{
    [Route("api/[controller]")]
    public class ItemsController : Controller
    {
        // GET: api/items
        [HttpGet()]
        public IEnumerable<string> Get()
        {
            return GetLatestItems();
        }

        // GET: api/items/5
        [HttpGet("{num}")]
        public IEnumerable<string> Get(int num)
        {
            return GetLatestItems(5);
        }       

        // GET: api/items/GetLatestItems
        [HttpGet("GetLatestItems")]
        public IEnumerable<string> GetLatestItems()
        {
            return GetLatestItems(5);
        }

        // GET api/items/GetLatestItems/5
        [HttpGet("GetLatestItems/{num}")]
        public IEnumerable<string> GetLatestItems(int num)
        {
            return new string[] { "test", "test2" };
        }

        // POST: /api/items/PostSomething
        [HttpPost("PostSomething")]
        public IActionResult Post([FromBody]string someData)
        {
            return Content("OK, got it!");
        }
    }
}

此控制器将处理以下请求：

 [GET] api/items
 [GET] api/items/5
 [GET] api/items/GetLatestItems
 [GET] api/items/GetLatestItems/5
 [POST] api/items/PostSomething

另请注意，如果使用这两种方法，基于属性的路由（定义时）将覆盖基于约定的路径，并且它们都将覆盖UseMvc()定义的默认路由。

有关详细信息，您还可以在我的博客上read the following post。

Answer 7

Web APi 2和更高版本支持一种新型的路由，称为属性路由。顾名思义，属性路由使用属性来定义路由。通过属性路由，您可以更好地控制Web API中的URI。例如，您可以轻松创建描述资源层次结构的URI。

例如：

[Route("customers/{customerId}/orders")]
public IEnumerable<Order> GetOrdersByCustomer(int customerId) { ... }

将是完美的，并且不需要任何额外的代码，例如WebApiConfig.cs中的代码。只需确保WebApiConfig.cs中启用或禁用了Web api路由，否则，您可以像下面这样激活：

        // Web API routes
        config.MapHttpAttributeRoutes();

您无需在WebApiConfig.cs中做更多的事情或更改某些内容。有关更多详细信息，请查看this article。

Answer 8

只需将您的WebAPIConfig.cs修改为以下

    // GET: api/Controller_Name/Show/1
    [ActionName("Show")]
    [HttpGet]
    public EventPlanner Id(int id){}

然后将您的API实现为波纹管

fn main() {
    let mut faxvec: Vec<std::path::PathBuf> = Vec::new();
    for element in std::path::Path::new(r"C:\Testpath").read_dir().unwrap() {
        let path = element.unwrap().path();
        if let Some(extension) = path.extension() {
            if extension == "txt" {
                faxvec.push(path);
            }
        }
    }
}

ASP.NET Web API中的自定义方法名称

8 个答案: