ApiController 類別

  • 參考

定義

命名空間:
System.Web.Http
組件:
Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll
組件:
System.Web.Http.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

定義 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 不正確的要求) 。
BadRequest(ModelStateDictionary)

使用 InvalidModelStateResult 指定的模型狀態建立 (400 不正確的要求) 。
BadRequest(String)

使用指定的錯誤訊息，建立 BadRequestErrorMessageResult (400 不正確的要求) 。
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()

執行與釋放 (Free)、釋放 (Release) 或重設 Unmanaged 資源相關聯之應用程式定義的工作。
Dispose(Boolean)

釋放物件所使用的 Unmanaged 資源，並選擇性地釋放 Managed 資源。
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 。

適用於