Perbedaan antara ApiController dan Controller di ASP.NET MVC

Saya telah bermain-main dengan ASP.NET MVC 4 beta dan saya melihat dua jenis pengendali sekarang: ApiControllerdan Controller.

Saya agak bingung pada situasi apa saya bisa memilih pengontrol tertentu.

Sebagai contoh: Jika saya ingin mengembalikan tampilan maka saya harus menggunakan ApiControlleratau biasa Controller? Saya sadar bahwa API Web WCF sekarang terintegrasi dengan MVC.

Karena sekarang kita dapat menggunakan kedua pengendali tersebut, tolong tolong tunjukkan situasi apa yang harus dilakukan untuk pengontrol yang sesuai.

Gunakan Pengontrol untuk membuat tampilan normal Anda. Tindakan ApiController hanya mengembalikan data yang diserialisasi dan dikirim ke klien.

ini tautannya

Mengutip:

Catatan Jika Anda telah bekerja dengan ASP.NET MVC, maka Anda sudah terbiasa dengan pengontrol. Mereka bekerja serupa di Web API, tetapi pengontrol di Web API berasal dari kelas ApiController bukan kelas Controller. Perbedaan besar pertama yang akan Anda perhatikan adalah bahwa tindakan pada pengontrol API Web tidak mengembalikan tampilan, mereka mengembalikan data.

ApiControllers memiliki spesialisasi dalam mengembalikan data. Misalnya, mereka menangani serialisasi data secara transparan ke dalam format yang diminta oleh klien. Juga, mereka mengikuti skema perutean yang berbeda secara default (seperti dalam: memetakan URL ke tindakan), menyediakan API REST-ful berdasarkan konvensi.

Anda mungkin dapat melakukan apa saja menggunakan Pengontrol alih-alih ApiController dengan beberapa (?) Pengkodean manual. Pada akhirnya, kedua kontroler dibangun di atas dasar ASP.NET. Tetapi memiliki API REST-ful adalah persyaratan yang umum saat ini sehingga WebAPI dibuat untuk menyederhanakan implementasi API semacam itu.

Cukup mudah untuk memutuskan di antara keduanya: jika Anda menulis aplikasi web / internet / intranet berbasis HTML - mungkin dengan panggilan AJAX sesekali mengembalikan json di sana-sini - tetap dengan MVC / Controller. Jika Anda ingin memberikan antarmuka data-driven / REST-ful ke sistem, pergi dengan WebAPI. Anda dapat menggabungkan keduanya, tentu saja, memiliki ApiController yang melayani panggilan AJAX dari halaman MVC.

Untuk memberikan contoh dunia nyata: Saat ini saya sedang bekerja dengan sistem ERP yang menyediakan API REST-ful untuk entitasnya. Untuk API ini, WebAPI akan menjadi kandidat yang baik. Pada saat yang sama, sistem ERP menyediakan aplikasi web yang sangat AJAX-ified yang dapat Anda gunakan untuk membuat kueri untuk API REST-ful. Aplikasi web itu sendiri dapat diimplementasikan sebagai aplikasi MVC, memanfaatkan WebAPI untuk mengambil meta-data dll.

Mana yang ingin Anda tulis dan pertahankan?

ASP.NET MVC

public class TweetsController : Controller {
  // GET: /Tweets/
  [HttpGet]
  public ActionResult Index() {
    return Json(Twitter.GetTweets(), JsonRequestBehavior.AllowGet);
  }
}

ASP.NET Web API

public class TweetsController : ApiController {
  // GET: /Api/Tweets/
  public List<Tweet> Get() {
    return Twitter.GetTweets();
  }
}

Saya suka fakta bahwa ASP.NET Core's MVC6 menggabungkan dua pola menjadi satu karena saya sering perlu mendukung kedua dunia. Meskipun benar bahwa Anda dapat mengubah MVC standar apa pun Controller(dan / atau mengembangkan ActionResultkelas Anda sendiri ) untuk bertindak & berperilaku seperti ApiController, itu bisa sangat sulit untuk mempertahankan dan menguji: di atas itu, memiliki metode Pengendali kembali ActionResultdicampur dengan yang lain mengembalikan mentah / serial / IHttpActionResultdata bisa sangat membingungkan dari perspektif pengembang, terutama jika Anda tidak bekerja sendiri dan perlu membawa pengembang lain untuk mempercepat dengan pendekatan hybrid.

Teknik terbaik yang saya lakukan sejauh ini untuk meminimalkan masalah itu dalam aplikasi web non-Core ASP.NET adalah mengimpor (dan mengonfigurasi dengan benar) paket Web API ke dalam Aplikasi Web berbasis-MVC, sehingga saya dapat memiliki yang terbaik dari keduanya worlds: Controllersfor Views, ApiControllersuntuk data.

Untuk melakukan itu, Anda perlu melakukan hal berikut:

• Instal paket Web API berikut menggunakan NuGet: Microsoft.AspNet.WebApi.Coredan Microsoft.AspNet.WebApi.WebHost.
• Tambahkan satu atau lebih ApiControllers ke /Controllers/folder Anda .
• Tambahkan file WebApiConfig.cs berikut ke /App_Config/folder Anda :

using System.Web.Http;

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API routes
        config.MapHttpAttributeRoutes();

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

Terakhir, Anda harus mendaftarkan kelas di atas ke kelas Startup Anda (salah satu Startup.csatau Global.asax.cs, tergantung apakah Anda menggunakan template Startup OWIN atau tidak).

Startup.cs

 public void Configuration(IAppBuilder app)
 {
    // Register Web API routing support before anything else
    GlobalConfiguration.Configure(WebApiConfig.Register);

    // The rest of your file goes there
    // ...
    AreaRegistration.RegisterAllAreas();
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);

    ConfigureAuth(app);
    // ...
}

Global.asax.cs

protected void Application_Start()
{
    // Register Web API routing support before anything else
    GlobalConfiguration.Configure(WebApiConfig.Register);

    // The rest of your file goes there
    // ...
    AreaRegistration.RegisterAllAreas();
    FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
    RouteConfig.RegisterRoutes(RouteTable.Routes);
    BundleConfig.RegisterBundles(BundleTable.Bundles);
    // ...
}

Pendekatan ini - bersama dengan pro dan kontra - dijelaskan lebih lanjut dalam posting ini yang saya tulis di blog saya.

Setiap metode di Web API akan mengembalikan data (JSON) tanpa serialisasi.

Namun, untuk mengembalikan Data JSON di pengontrol MVC, kami akan menetapkan tipe Hasil Tindakan yang dikembalikan ke JsonResult dan memanggil metode Json pada objek kami untuk memastikannya dikemas dalam JSON.

Perbedaan utamanya adalah: API Web adalah layanan untuk klien apa pun, perangkat apa pun, dan Pengontrol MVC hanya melayani kliennya. Sama karena itu adalah platform MVC.

Cukup mudah untuk memutuskan di antara keduanya: jika Anda menulis aplikasi web / internet / intranet berbasis HTML - mungkin dengan panggilan AJAX sesekali mengembalikan json di sana-sini - tetap dengan MVC / Controller. Jika Anda ingin memberikan antarmuka data-driven / REST-ful ke sistem, pergi dengan WebAPI. Anda dapat menggabungkan keduanya, tentu saja, memiliki ApiController yang melayani panggilan AJAX dari halaman MVC. Pada dasarnya controller digunakan untuk mvc dan api-controller digunakan untuk Rest-API Anda dapat menggunakan keduanya dalam program yang sama dengan kebutuhan Anda