ApiController 类

定义

命名空间:

System.Web.Http

程序集:

System.Web.Http.dll

为 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。
ControllerContext	获取或设置 ControllerContext。
ModelState	获取模型绑定过程之后的模型状态。 在进行模型绑定之前，此 ModelState 将为空。
Request	获取或设置 HTTP 请求消息。
Url	获取用于生成其他 API 的 URL 的工厂。
User	获取或设置与此请求关联的当前主体。

方法

BadRequest()	创建 BadRequestResult (400 错误请求) 。
BadRequest(String)	BadRequestErrorMessageResult 使用指定的错误消息创建 (400 错误请求) 。
Conflict()	创建 ConflictResult (409 冲突) 。
Content<T>(HttpStatusCode, T)	NegotiatedContentResult<T>使用指定的值创建 。
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