ชื่อเมธอดที่กำหนดเองใน ASP.NET Web API

ฉันกำลังแปลงจาก 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} & password = {1} จากนั้นจะเรียก Get (NOT Authenticate) และ error:

พจนานุกรมพารามิเตอร์มีรายการ null สำหรับพารามิเตอร์ 'id' ของประเภทที่ไม่เป็นโมฆะ 'System.Int32' สำหรับเมธอด 'System.String Get (Int32)' ใน 'Navtrak.Services.WCF.NavtrakAPI.Controllers.UsersController' พารามิเตอร์ที่เป็นทางเลือกต้องเป็นประเภทการอ้างอิงประเภทที่เป็นโมฆะหรือถูกประกาศเป็นพารามิเตอร์ทางเลือก

ฉันจะเรียกชื่อเมธอดแบบกำหนดเองเช่น Authenticate ได้อย่างไร?

โดยค่าเริ่มต้นการกำหนดค่าเส้นทางเป็นไปตามข้อกำหนด RESTFul ซึ่งหมายความว่าจะยอมรับเฉพาะชื่อการดำเนินการรับโพสต์ใส่และลบ (ดูที่เส้นทางใน global.asax => โดยค่าเริ่มต้นจะไม่อนุญาตให้คุณระบุชื่อการดำเนินการใด ๆ => ใช้กริยา HTTP เพื่อส่ง) ดังนั้นเมื่อคุณส่งคำขอ GET ถึง/api/users/authenticateคุณโดยทั่วไปจะเรียกการ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เพื่อตรวจสอบผู้ใช้

นี่เป็นวิธีที่ดีที่สุดที่ฉันได้คิดขึ้นมาเพื่อรวมวิธีการ GET พิเศษในขณะที่สนับสนุนวิธี REST ปกติด้วย เพิ่มเส้นทางต่อไปนี้ใน 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 พิเศษของคุณไม่ได้ขึ้นต้นด้วย "รับ" คุณอาจต้องการเพิ่มแอตทริบิวต์ HttpGet ให้กับวิธีการ

ฉันเป็นวันที่เข้าสู่โลก 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}"
 );

ตราบเท่าที่ฉันตั้งชื่อ {การจัดการ} เป็น {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."
}

เมื่อฉันเปลี่ยนชื่อเป็น {การจัดการ} มันเริ่มทำงาน เห็นได้ชัดว่าชื่อพารามิเตอร์ตรงกับค่าในตัวยึด

อย่าลังเลที่จะแก้ไขคำตอบนี้เพื่อให้ถูกต้อง / อธิบายได้มากขึ้น

โดยค่าเริ่มต้น Web Api จะคาดหวัง URL ในรูปแบบของ api / {controller} / {id} เพื่อแทนที่การกำหนดเส้นทางเริ่มต้นนี้ คุณสามารถกำหนดเส้นทางด้วยวิธีใดก็ได้จากสองวิธีด้านล่างนี้

ตัวเลือกแรก:

เพิ่มการลงทะเบียนเส้นทางด้านล่างใน 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

}

สำหรับการเรียก method url ข้างต้นจะเป็นดังนี้

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

ตัวเลือกที่สอง เพิ่มคำนำหน้าเส้นทางไปยังคลาสคอนโทรลเลอร์และตกแต่งวิธีการดำเนินการของคุณด้วย HttpGet ดังต่อไปนี้ ในกรณีนี้ไม่จำเป็นต้องเปลี่ยน WebApiConfig.cs สามารถมีการกำหนดเส้นทางเริ่มต้น

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

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

{

// your code here

}

}

สำหรับการเรียก method url ข้างต้นจะเป็นดังนี้

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

ในกรณีที่คุณใช้ASP.NET 5กับASP.NET MVC 6คำตอบเหล่านี้ส่วนใหญ่จะใช้ไม่ได้เพราะโดยปกติคุณจะปล่อยให้ MVC สร้างคอลเลคชันเส้นทางที่เหมาะสมสำหรับคุณ (โดยใช้ข้อตกลง RESTful เริ่มต้น) ซึ่งหมายความว่า คุณจะไม่พบการRoutes.MapRoute()เรียกให้แก้ไขตามต้องการ

ConfigureServices()วิธีการเรียกใช้โดยStartup.csไฟล์จะลงทะเบียน MVC กับกรอบการพึ่งพาการฉีดที่สร้างขึ้นใน ASP.NET ที่ 5: วิธีการที่เมื่อคุณเรียก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());
}

สิ่งที่ดีเกี่ยวกับเรื่องนี้คือตอนนี้เฟรมเวิร์กจัดการงานหนักทั้งหมดทำซ้ำผ่านการดำเนินการทั้งหมดของคอนโทรลเลอร์และการตั้งค่าเส้นทางเริ่มต้นซึ่งช่วยให้คุณประหยัดงานที่ซ้ำซ้อน

สิ่งที่แย่คือมีเอกสารเพียงเล็กน้อยหรือไม่มีเลยเกี่ยวกับวิธีเพิ่มเส้นทางของคุณเอง โชคดีที่คุณสามารถทำได้อย่างง่ายดายโดยใช้วิธีการตามอนุสัญญาและ / หรือวิธีการตามแอตทริบิวต์ (aka Attribute Routing )

ตามอนุสัญญา

ในคลาส 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

นอกจากนี้โปรดสังเกตว่าหากคุณใช้ togheter สองวิธีเส้นทางตามแอตทริบิวต์ (เมื่อกำหนด) จะแทนที่เส้นทางที่อิงตามอนุสัญญาและทั้งสองวิธีจะแทนที่เส้นทางเริ่มต้นที่กำหนดโดย UseMvc()และทั้งสองของพวกเขาจะแทนที่เส้นทางเริ่มต้นที่กำหนดโดย

สำหรับข้อมูลเพิ่มเติมคุณสามารถอ่านโพสต์ต่อไปนี้ในบล็อกของฉัน

ดูบทความนี้สำหรับการอภิปรายอีกต่อไปเกี่ยวกับการกระทำที่ตั้งชื่อ นอกจากนี้ยังแสดงให้เห็นว่าคุณสามารถใช้แอตทริบิวต์ [HttpGet] แทนการขึ้นต้นชื่อการกระทำด้วย "get"

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

เพียงแค่ปรับเปลี่ยน WebAPIConfig.cs ของคุณดังต่อไปนี้

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

จากนั้นใช้ API ของคุณดังต่อไปนี้

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

Web APi 2 และเวอร์ชันที่ใหม่กว่ารองรับการกำหนดเส้นทางประเภทใหม่เรียกว่าการกำหนดเส้นทางแอตทริบิวต์ ตามความหมายของชื่อการกำหนดเส้นทางแอตทริบิวต์ใช้แอตทริบิวต์เพื่อกำหนดเส้นทาง การกำหนดเส้นทางแอตทริบิวต์ช่วยให้คุณควบคุม URI ใน Web API ได้มากขึ้น ตัวอย่างเช่นคุณสามารถสร้าง URI ที่อธิบายลำดับชั้นของทรัพยากรได้อย่างง่ายดาย

ตัวอย่างเช่น:

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

จะสมบูรณ์แบบและคุณไม่จำเป็นต้องใช้รหัสพิเศษใด ๆ เช่นใน WebApiConfig.cs เพียงแค่คุณต้องแน่ใจว่าเปิดใช้งานการกำหนดเส้นทางเว็บ api หรือไม่ใน WebApiConfig.cs หากไม่สามารถเปิดใช้งานได้ดังนี้:

        // Web API routes
        config.MapHttpAttributeRoutes();

คุณไม่จำเป็นต้องทำอะไรเพิ่มเติมหรือเปลี่ยนแปลงบางอย่างใน WebApiConfig.cs สำหรับรายละเอียดเพิ่มเติมสามารถดูได้ในบทความนี้