ASP.NET Web API

提供: MonoBook
移動: 案内検索

ASP.NET Web APIとは、ASP.NET MVC 4で追加されたRESTfulなサービスを構築するためのフレームワークである。 現在はASP.NET MVCの一部ではなく完全に分離されて単独のフレームワークとしてNuGetで提供されている。

ASP.NET MVC と ASP.NET Web API[編集]

ASP.NET Web API 1.0[編集]

ASP.NET Web APIは、ASP.NET MVC 4のパッケージに同梱されているだけであり、従来のASP.NET MVCとはまったく別物である点に注意すること。

たとえば、アクションコントローラーの根底にあるインターフェイスASP.NET MVCではIControllerだが(ASP.NET無印と共通)、ASP.NET Web APIではまったく新規に登場したIHttpControllerとなっている。またアクションの戻り値もActionResultではなくHttpResponseMessageとなっているなど、「名前は似ているが全くの別物が用意されている」と認識しておく必要がある。

ASP.NET Web API 2.0[編集]

ASP.NET Web API 2.0以降では単体で動くようになりNuGetから簡単に環境を構築し利用できる。またMonoでも問題なく利用できるようになりMac OS X上のXamarin Studioでの開発も可能になった。またXamarin Studio 6.0およびMono 4.4ではWeb APIを標準で利用できるようになり、ASP.NET系の新規プロジェクト作成時にWeb API利用の有無を選択するチェックボックスが搭載され、より手軽に利用できるようになっている。

RESTful[編集]

ASP.NET Web API では新しい強く型付けされた HTTP オブジェクトモデルを使って HTTP リクエストとレスポンスを直接操作できる。

ASP.NET MVCのデフォルトのルーティングは以下のようになっている。

routes.MapRoute(
    "Default", 
    "{controller}/{action}/{id}", 
    new { controller = "Home", action = "Index", id = UrlParameter.Optional } 
);

一方、ASP.NET Web APIのデフォルトのルーティングは以下のようになっている。

routes.MapHttpRoute(
    "DefaultApi",
    "api/{controller}/{id}",
    new { id = RouteParameter.Optional }
);

どちらもcontroller(コントローラー名)とid(引数)をとるのは共通だが、ASP.NET Web APIではactionが無くなっており、RESTのルール(HTTPリクエストメソッドの種類)に応じて強制的にアクションが決定する。従って、HttpPostなどの属性をクラスやメソッドに付加する必要がない(「ASP.NET MVC/セレクター」も参照)。

基本ルール[編集]

まずHTTPリクエストメソッドの種類がそのままCRUDに対応している。

HTTPリクエストメソッド アクション
GET (idなし) 全データを取得する。
GET (id指定) idで指定されたデータ取得する。
POST 新しいデータを追加する。
PUT idで指定されたデータを更新する。
DELETE idで指定されたデータを削除する。
  • GET /api/user/100
  • userControllerクラスのGet(100)メソッドが呼ばれる

この他のメソッド名にすると明示的に指定するメソッドになる。

  • GET /api/user/search?name=abc
  • userControllerクラスのsearch(abc)メソッドが呼ばれる。

その他[編集]

関連項目[編集]

参考文献[編集]