วิธีเพิ่ม Web API ในโครงการ ASP.NET MVC (5) Web Application ที่มีอยู่

สมมติว่าคุณลืมทำเครื่องหมายที่ช่องทำเครื่องหมาย Web API (เพิ่มในโครงการ) เมื่อสร้างโครงการ MVC (5) ใหม่คุณต้องทำอะไรเพิ่ม Web API เพื่อให้ทำงานได้

มีคำถามเกี่ยวกับการย้ายข้อมูลจำนวนมาก แต่ดูเหมือนว่าจะไม่มีขั้นตอนที่สมบูรณ์และทันสมัยสำหรับการเพิ่ม Web API ในโครงการ MVC 5 และดูเหมือนว่าจะเปลี่ยนไปจากคำตอบเดิมบางส่วน

เพิ่ม Web API ใน MVC 4

การเพิ่ม GlobalConfiguration.Configure (WebApiConfig.Register) MVC 4

อัพเดทโครงการ MVC

ใช้Nugetเพื่อรับ Web API ใหม่ล่าสุด

โครงการ - คลิกขวา - จัดการแพคเกจ Nuget - ค้นหา Web API (Microsoft ASP.NET Web API ... ) และติดตั้งลงในโครงการ MVC ของคุณ

จากนั้นคุณยังคงต้องใช้การกำหนดเส้นทางของเว็บ APIเพื่อให้ทำงานได้ จากการกำหนดค่า ASP.NET Web API 2 ของ Microsoft

เพิ่ม WebApiConfig.cs ไปยัง App_Start / โฟลเดอร์

using System.Web.Http;

namespace WebApplication1
{
    public static class WebApiConfig
    {
        public static void Register(HttpConfiguration config)
        {
            // TODO: Add any additional configuration code.

            // Web API routes
            config.MapHttpAttributeRoutes();

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

        // WebAPI when dealing with JSON & JavaScript!
        // Setup json serialization to serialize classes to camel (std. Json format)
        var formatter = GlobalConfiguration.Configuration.Formatters.JsonFormatter;
        formatter.SerializerSettings.ContractResolver =
            new Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver();
        }
    }
}

หากคุณมีโครงการ MVC จะมีGlobal.asax.csเพิ่มเส้นทางใหม่ คำสั่งของเส้นทาง Global.asax.cs นั้นสำคัญมาก หมายเหตุมีตัวอย่างที่ล้าสมัยซึ่งใช้ WebApiConfig.Register

เพิ่มบรรทัดนี้ใน Global.asax.cs: GlobalConfiguration.Configure(WebApiConfig.Register);

protected void Application_Start()
{
    // Default stuff
    AreaRegistration.RegisterAllAreas();

    // Manually installed WebAPI 2.2 after making an MVC project.
    GlobalConfiguration.Configure(WebApiConfig.Register); // NEW way
    //WebApiConfig.Register(GlobalConfiguration.Configuration); // DEPRECATED

    // Default stuff
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
}

ช่วยเหลือ WebAPI

ในการรับหน้าช่วยเหลือของ WebAPI ( มีประโยชน์ ) ให้ติดตั้ง WebAPI.HelpPage ดูhttp://channel9.msdn.com/Events/Build/2014/3-644 (ประมาณ 42 นาที) สำหรับสิ่งที่ทำ มันดูมีประโยชน์มาก!

คอนโซล Nuget: Install-Package Microsoft.AspNet.WebApi.HelpPage

วิธีตรวจสอบ WebAPI ทำงาน:

ไปยังโฟลเดอร์ตัวควบคุม -> เพิ่มรายการใหม่ -> Web API Controller Class

public class TestController : ApiController
{
    //public TestController() { }

    // GET api/<controller>
    public IEnumerable<string> Get()
    {
        return new string[] { "value1", "value2" };
    }

    // GET api/<controller>/5
    public string Get(int id)
    {
        return "value";
    }
    //...
}

ตอนนี้คุณสามารถทดสอบใน IE / FF / Chrome ได้ตามปกติหรือในคอนโซล JavaScript สำหรับการทดสอบที่ไม่ได้รับ

(มีเพียงตัวควบคุมใน URL มันจะเรียกการกระทำของ GET () ใน Web API Controller ใหม่มันจะถูกแมปกับวิธีการ / การกระทำโดยอัตโนมัติขึ้นอยู่กับส่วนที่เหลือเช่น PUT / POST / GET / DELETE คุณไม่จำเป็นต้องโทร พวกเขาโดยการกระทำเหมือนใน MVC) URL โดยตรง:

http://localhost:PORT/api/CONTROLLERNAME/

หรือใช้ jQuery เพื่อสอบถามคอนโทรลเลอร์ เรียกใช้โครงการเปิดคอนโซล (F12 ใน IE) และลองเรียกใช้แบบสอบถาม Ajax (ตรวจสอบ PORT & CONTROLLERNAME ของคุณ)

$.get( "http://localhost:PORT/api/CONTROLLERNAME/", function( data ) {
    //$( ".result" ).html( data );
    alert( "Get data received:" + data);
});

หมายเหตุด้านข้าง: มีข้อดี / ข้อเสียบางประการที่ควรพิจารณาเมื่อรวม MVC และ Web API ในโครงการ

การตรวจสอบวิธีใช้ WebAPI: http://localhost:PORT/help