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


146

新しいMVC(5)プロジェクトを作成するときにWeb APIチェックボックス(プロジェクトに追加)にチェックマークを付けるのを忘れた場合、Web APIを追加して機能させるには何が必要ですか?

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

MVC 4にWeb APIを追加する

GlobalConfiguration.Configure(WebApiConfig.Register)MVC 4の追加

回答:


253

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

Nugetを使用して最新のWeb APIを取得します。

プロジェクト-右クリック-Nugetパッケージの管理-Web API(Microsoft ASP.NET Web API ...)を検索し、MVCプロジェクトにインストールします。

次に、Web APIルーティングを機能させる必要があります。Microsoftの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ヘルプ

非常に役立つ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()アクションが呼び出されます。PUT/ POST / GET / DELETEなど、RESTに応じてメソッド/アクションに自動的にマップされます。呼び出す必要はありません。 MVCのようなアクションによってそれら)直接URL:

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

または、jQueryを使用してコントローラーをクエリします。プロジェクトを実行し、コンソール(IEではF12)を開いて、Ajaxクエリを実行してみます。(ポートとコントローラー名を確認してください)

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

補足:プロジェクトでMVCとWeb APIを組み合わせる際に考慮すべき賛否両論があります。

WebAPIヘルプの検証: http://localhost:PORT/help


@Iko私はあなたがコードに書いたすべてのことをしましたが、それを実行するとエラーになります。エラーが発生します
ninjaXnado 14

1
エラーメッセージを検索してみてください。これらの手順は基本的に、一般的なケースで必要なものでした。
lko

13
「Global.asax.csルートの順序は重要です」+1
ジム・アホ

Web APIを正しく追加したかどうかをテストする方法を理解できませんでしたか?ブラウザに正確に何を書けばよいですか?書いたhttp://localhost:12345/api/Get/5がエラーが出た。
ジェイソン

3
私はWebApiConfig.Register(GlobalConfiguration.configuration);を呼び出す「古い方法」を使用していました。もうデバッグできませんでした。デバッグを開始しましたが、コントローラーの機能に到達できませんでした。「新しい方法」に変更したGlobalConfiguration.Configure(WebApiConfig.Register); そして問題は修正されました。
D.カーモット2016年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.