ApiController クラス

  • リファレンス

定義

名前空間:
System.Web.Http
アセンブリ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll
パッケージ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim v1.0.0
パッケージ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim v1.1.0
パッケージ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.0.0
パッケージ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.1.0
パッケージ:
Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.2.0
ソース:
ApiController.cs
ソース:
ApiController.cs

API コントローラーのプロパティとメソッドを定義します。

[Microsoft.AspNetCore.Mvc.Controller]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiActionConventions]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiOverloading]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiParameterConventions]
[Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiRoutes]
public abstract class ApiController : IDisposable
[<Microsoft.AspNetCore.Mvc.Controller>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiActionConventions>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiOverloading>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiParameterConventions>]
[<Microsoft.AspNetCore.Mvc.WebApiCompatShim.UseWebApiRoutes>]
type ApiController = class
    interface IDisposable
Public MustInherit Class ApiController
Implements IDisposable
継承
Object
ApiController
属性
ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute
実装
IDisposable

コンストラクター

ApiController()

API コントローラーのプロパティとメソッドを定義します。

プロパティ

ActionContext

ActionContext を取得します。
Context

http コンテキストを取得します。
ControllerContext

ControllerContext を取得または設定します。
MetadataProvider

IModelMetadataProvider を取得します。
ModelState

モデル バインド プロセスの後のモデルの状態を取得します。 モデル バインディングが発生する前に、この ModelState は空になります。
ObjectValidator

IObjectModelValidator を取得または設定します。
Request

HTTP 要求メッセージを取得または設定します。
Url

他の API への URL を生成するために使用されるファクトリを取得します。
User

この要求に関連付けられている現在のプリンシパルを取得または設定します。

メソッド

BadRequest()

BadRequestResult (400 Bad Request) を作成します。
BadRequest(ModelStateDictionary)

指定したモデル状態の InvalidModelStateResult (400 Bad Request) を作成します。
BadRequest(String)

指定したエラー メッセージを BadRequestErrorMessageResult 含む (400 Bad Request) を作成します。
Conflict()

ConflictResult (409 競合) を作成します。
Content<T>(HttpStatusCode, T)

NegotiatedContentResult<T>指定した値を使用して を作成します。
Created(String, Object)

指定した値を使用して CreatedResult ( 201 Created) を作成します。
Created(Uri, Object)

指定した値を使用して CreatedResult ( 201 Created) を作成します。
CreatedAtRoute(String, Object, Object)

指定した値を使用して CreatedAtRouteResult ( 201 Created) を作成します。
Dispose()

アンマネージ リソースの解放またはリセットに関連付けられているアプリケーション定義のタスクを実行します。
Dispose(Boolean)

オブジェクトによって使用されているアンマネージド リソースを解放し、オプションでマネージド リソースも解放します。
InternalServerError()

InternalServerErrorResult (500 内部サーバー エラー) を作成します。
InternalServerError(Exception)

指定した例外を含 ExceptionResult む (500 内部サーバー エラー) を作成します。
Json<T>(T)

指定した値を JsonResult 持つ (200 OK) を作成します。
Json<T>(T, JsonSerializerSettings)

指定した値を使用して JsonResult (200 OK) を作成します。
Json<T>(T, JsonSerializerSettings, Encoding)

指定した値を使用して JsonResult (200 OK) を作成します。
NotFound()

NotFoundResult (404 が見つかりません) を作成します。
Ok()

OkResult (200 OK) を作成します。
Ok<T>(T)

指定した値を使用して OkObjectResult (200 OK) を作成します。
Redirect(String)

指定した値を RedirectResult 持つ (302 Found) を作成します。
Redirect(Uri)

指定した値を RedirectResult 持つ (302 Found) を作成します。
RedirectToRoute(String, Object)

指定した値を使用して RedirectToRouteResult (302 Found) を作成します。
ResponseMessage(HttpResponseMessage)

ResponseMessageResult指定した応答を使用して を作成します。
StatusCode(HttpStatusCode)

StatusCodeResult指定した状態コードを使用して を作成します。
Validate<TEntity>(TEntity)

指定されたエンティティを検証し、空のプレフィックスの下の に ModelState 検証エラーを追加します。
Validate<TEntity>(TEntity, String)

指定されたエンティティを検証し、検証エラーを に追加します ModelState。

適用対象