web-dev-qa-db-ja.com

既存のASP.NET MVC（5）WebアプリケーションプロジェクトにWeb APIを追加する方法

新しいMVC（5）プロジェクトを作成するときにWeb APIチェックボックスを選択する（プロジェクトに追加する）のを忘れたとしたら、Web APIを追加して機能させるために何をする必要がありますか？

移行に関する質問はたくさんありますが、Web APIをMVC 5プロジェクトに追加するための完全かつ最新の手順を持っているようには見えず、いくつかのものから変更されたようです。昔の答え

MVC 4にWeb APIを追加

GlobalConfiguration.Configure（WebApiConfig.Register）MVC 4の追加

c#asp.netasp.net-mvcasp.net-web-apiasp.net-mvc-5
137
lko

MVCプロジェクトを更新する

最新のWeb APIを取得するには、Nugetを使用します。

プロジェクト - 右クリック Manage Nuget Packages] - [Web API]（Microsoft ASP.NET Web API ...）を検索して、MVCプロジェクトにインストールします。

それでも、あなたはまだWeb APIルーティングを動作させる必要があります。 From --- [マイクロソフトのASP.NET Web API 2を構成する

App_Start /フォルダにWebApiConfig.csを追加します

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ヘルプ

（very） 役立つWebAPIヘルプページ を入手するには、WebAPI.HelpPageをインストールしてください。それが何をするかについては http://channel9.msdn.com/Events/Build/2014/3-644 （〜42分）を参照してください。とても参考になります。

Nugetコンソール：Install-Package Microsoft.AspNet.WebApi.HelpPage

WebAPIが機能していることを確認するには

コントローラフォルダに - >新しい項目を追加 - > Web APIコントローラクラス。

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でテストできます。または、get以外のテストではJavaScriptコンソールでテストできます。

（URL内のコントローラーだけで新しいWeb APIコントローラーのGET（）アクションを呼び出します。これはRESTに応じて自動的にメソッド/アクションにマッピングされます（例：PUT/POST/GET/DELETE）。 MVC）URLのように、アクションでそれらを呼び出す必要はありません。

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

またはjQueryを使ってコントローラに問い合わせます。プロジェクトを実行し、コンソールを開いて（IEではF12）、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

241
lko