1. ホーム
  2. c#

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

2022-04-28 07:34:27

質問

MVC(5)の新規プロジェクト作成時に、Web APIのチェックボックスにチェックを入れる(プロジェクトに追加する)のを忘れたと仮定して、Web APIを追加して動作させるには、どうしたらよいでしょうか。

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

MVC 4にWeb APIを追加する

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

解決方法は?

MVCプロジェクトの更新

使用方法 ナゲット をクリックすると、最新のWeb APIを取得できます。

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

それから、まだ Web API ルーティング を動作させることができます。 から マイクロソフトのConfiguring ASP.NET Web API 2

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 プロジェクトを作成した場合、そのプロジェクトには グローバル.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が動作していることを確認するため。

controllers フォルダに -> 新規項目 -> 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でテストできます。また、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