Różnica między ApiController a kontrolerem w ASP.NET MVC

Bawiłem się z ASP.NET MVC 4 beta i teraz widzę dwa typy kontrolerów: ApiControlleri Controller.

Nie jestem zdezorientowany, w jakich sytuacjach mogę wybrać konkretnego kontrolera.

Na przykład: jeśli chcę zwrócić widok, muszę użyć ApiControllerlub zwykłego Controller? Wiem, że interfejs API sieci WCF jest teraz zintegrowany z MVC.

Ponieważ teraz możemy korzystać z obu kontrolerów, ktoś może wskazać, w jakich sytuacjach wybrać odpowiedni kontroler.

Użyj kontrolera, aby renderować swoje normalne widoki. Działanie ApiController zwraca tylko dane, które są serializowane i wysyłane do klienta.

tutaj jest link

Zacytować:

Uwaga Jeśli pracujesz z ASP.NET MVC, znasz już kontrolery. Działają podobnie w Web API, ale kontrolery w Web API pochodzą z klasy ApiController zamiast z klasy Controller. Pierwszą znaczącą różnicą, którą zauważysz, jest to, że działania na kontrolerach interfejsu API sieci Web nie zwracają widoków, tylko dane.

ApiControllery specjalizują się w zwracaniu danych. Na przykład dbają o przejrzystą serializację danych do formatu żądanego przez klienta. Ponadto domyślnie stosują inny schemat routingu (jak w: mapowanie adresów URL na działania), zapewniając zgodnie z konwencją interfejs API REST.

Prawdopodobnie możesz zrobić wszystko przy użyciu kontrolera zamiast ApiController z niektórymi (?) Kodowaniami ręcznymi. Ostatecznie oba kontrolery bazują na platformie ASP.NET. Ale posiadanie interfejsu API REST jest dzisiaj tak powszechnym wymogiem, że interfejs WebAPI został utworzony w celu uproszczenia implementacji takiego interfejsu API.

Wybór między tymi dwoma jest dość prosty: jeśli piszesz aplikację internetową / internetową / intranetową opartą na HTML - być może przy sporadycznym wywołaniu AJAX zwracającym json tu i tam - trzymaj się MVC / kontrolera. Jeśli chcesz zapewnić systemowi interfejs oparty na danych / REST, skorzystaj z WebAPI. Można oczywiście połączyć oba, mając ApiController obsługujący wywołania AJAX ze strony MVC.

Podam przykład z prawdziwego świata: Obecnie pracuję z systemem ERP, który zapewnia interfejs API REST dla swoich podmiotów. W przypadku tego interfejsu API WebAPI byłby dobrym kandydatem. Jednocześnie system ERP zapewnia aplikację internetową o wysokim stopniu zaawansowania AJAX, której można używać do tworzenia zapytań do interfejsu API REST. Sama aplikacja internetowa może zostać zaimplementowana jako aplikacja MVC, wykorzystująca interfejs WebAPI do pobierania metadanych itp.

Który wolisz pisać i utrzymywać?

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();
  }
}

Uwielbiam fakt, że MVC6 programu ASP.NET Core połączył oba wzorce w jeden, ponieważ często muszę obsługiwać oba światy. Chociaż prawdą jest, że możesz dostosować dowolny standardowy MVC Controller(i / lub opracować własne ActionResultklasy), aby zachowywał się i zachowywał tak jak on ApiController, może być jednak bardzo trudny do utrzymania i przetestowania: na dodatek mieszanie metod kontrolerówActionResult z innymi zwracanie nieprzetworzonych / zserializowanych / IHttpActionResultdanych może być bardzo mylące z punktu widzenia programisty, szczególnie jeśli nie pracujesz sam i potrzebujesz przyspieszyć innych programistów dzięki temu hybrydowemu podejściu.

Najlepszą techniką, jaką do tej pory doszedłem do zminimalizowania tego problemu w nie-podstawowych aplikacjach internetowych ASP.NET, jest zaimportowanie (i poprawne skonfigurowanie) pakietu Web API do aplikacji internetowej opartej na MVC, dzięki czemu mogę mieć to, co najlepsze z obu światy: Controllersdla widoków, ApiControllersdla danych.

Aby to zrobić, musisz wykonać następujące czynności:

• Zainstaluj następujące pakiety interfejsu API sieci Web za pomocą NuGet: Microsoft.AspNet.WebApi.Corei Microsoft.AspNet.WebApi.WebHost.
• Dodaj jeden lub więcej ApiControllerów do swojego /Controllers/folderu.
• Dodaj następujący plik WebApiConfig.cs do swojego /App_Config/folderu:

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 }
        );
    }
}

Wreszcie, trzeba zarejestrować powyższą klasę do uruchomienia klasy (albo Startup.csalbo Global.asax.cs, zależnie od tego czy używasz szablonu OWIN startowy lub nie).

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);
    // ...
}

Podejście to - wraz z jego zaletami i wadami - wyjaśniono szerzej w tym poście, który napisałem na moim blogu.

Każda metoda w interfejsie API sieci Web zwraca dane (JSON) bez serializacji.

Aby jednak zwrócić dane JSON w kontrolerach MVC, ustawimy zwracany typ wyniku działania na JsonResult i wywołamy metodę Json na naszym obiekcie, aby upewnić się, że jest on spakowany w JSON.

Główna różnica polega na tym, że: Web API to usługa dla dowolnego klienta, dowolnego urządzenia, a MVC Controller obsługuje tylko swojego klienta. To samo, ponieważ jest to platforma MVC.

Wybór między tymi dwoma jest dość prosty: jeśli piszesz aplikację internetową / internetową / intranetową opartą na HTML - być może przy sporadycznym wywołaniu AJAX zwracającym json tu i tam - trzymaj się MVC / kontrolera. Jeśli chcesz zapewnić systemowi interfejs oparty na danych / REST, skorzystaj z WebAPI. Można oczywiście połączyć oba, mając ApiController obsługujący wywołania AJAX ze strony MVC. Zasadniczo kontroler służy do mvc, a kontroler interfejsu API służy do Rest-API, którego można używać zarówno w tym samym programie, jak potrzebujesz