ApiController Classe

Referência

Definição

Namespace:: System.Web.Http

Assembly:: Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll

Pacote:: Microsoft.AspNetCore.Mvc.WebApiCompatShim v1.0.0

Pacote:: Microsoft.AspNetCore.Mvc.WebApiCompatShim v1.1.0

Pacote:: Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.0.0

Pacote:: Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.1.0

Pacote:: Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.2.0

Origem:: ApiController.cs

Origem:: ApiController.cs

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Define as propriedades e métodos do controlador 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

Herança: Object
ApiController

Atributos: ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Implementações: IDisposable

Construtores

ApiController()

Define as propriedades e métodos do controlador API.

Propriedades

ActionContext	Obtém o ActionContext.
Context	Obtém o contexto http.
ControllerContext	Obtém ou define o ControllerContext.
MetadataProvider	Obtém o IModelMetadataProvider.
ModelState	Obtém o estado do modelo após o processo de associação de modelo. Este ModelState estará vazio antes do model binding acontecer.
ObjectValidator	Obtém ou define o IObjectModelValidator.
Request	Obtém ou define a mensagem de solicitação HTTP.
Url	Obtém uma fábrica usada para gerar URLs para outras APIs.
User	Obtém ou define a entidade de segurança atual associada a essa solicitação.

Métodos

BadRequest()	Cria um BadRequestResult (400 solicitação incorreta).
BadRequest(ModelStateDictionary)	Cria um (400 Solicitação InvalidModelStateResult Incorreta) com o estado do modelo especificado.
BadRequest(String)	Cria um BadRequestErrorMessageResult (400 Solicitação Incorreta) com a mensagem de erro especificada.
Conflict()	Cria um ConflictResult (Conflito 409).
Content<T>(HttpStatusCode, T)	Cria um NegotiatedContentResult<T> com os valores especificados.
Created(String, Object)	Cria um CreatedResult (201 Criado) com os valores especificados.
Created(Uri, Object)	Cria um CreatedResult (201 Criado) com os valores especificados.
CreatedAtRoute(String, Object, Object)	Cria um CreatedAtRouteResult (201 Criado) com os valores especificados.
Dispose()	Realiza tarefas definidas pelo aplicativo associadas à liberação ou à redefinição de recursos não gerenciados.
Dispose(Boolean)	Libera os recursos não gerenciados que são usados pelo objeto e, opcionalmente, libera os recursos gerenciados.
InternalServerError()	Cria um InternalServerErrorResult (erro interno de servidor 500).
InternalServerError(Exception)	Cria um ExceptionResult (500 Erro interno do servidor) com a exceção especificada.
Json<T>(T)	Cria um JsonResult (200 OK) com o valor especificado.
Json<T>(T, JsonSerializerSettings)	Cria um JsonResult (200 OK) com os valores especificados.
Json<T>(T, JsonSerializerSettings, Encoding)	Cria um JsonResult (200 OK) com os valores especificados.
NotFound()	Cria um NotFoundResult (404 Não Encontrado).
Ok()	Cria um OkResult (200 OK).
Ok<T>(T)	Cria um OkObjectResult (200 OK) com os valores especificados.
Redirect(String)	Cria um RedirectResult (302 Encontrado) com o valor especificado.
Redirect(Uri)	Cria um RedirectResult (302 Encontrado) com o valor especificado.
RedirectToRoute(String, Object)	Cria um RedirectToRouteResult (302 Encontrado) com os valores especificados.
ResponseMessage(HttpResponseMessage)	Cria um ResponseMessageResult com a resposta especificada.
StatusCode(HttpStatusCode)	Cria um StatusCodeResult com o código de status especificado.
Validate<TEntity>(TEntity)	Valida a entidade especificada e adiciona os erros de validação ao ModelState em um prefixo vazio.
Validate<TEntity>(TEntity, String)	Valida a entidade especificada e adiciona os erros de validação ao ModelState.

Aplica-se a

Compartilhar via