ApiController Třída

Definice

Obor názvů:

System.Web.Http

Sestavení:

Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll

Balíček:

Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.2.0

Zdroj:

ApiController.cs

Definuje vlastnosti a metody pro kontroler rozhraní 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

Dědičnost

Object

ApiController

Atributy

ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Implementuje

IDisposable

Konstruktory

ApiController()

Definuje vlastnosti a metody pro kontroler rozhraní API.

Vlastnosti

ActionContext	Získá .ActionContext
Context	Získá kontext http.
ControllerContext	Získá nebo nastaví ControllerContext.
MetadataProvider	Získá .IModelMetadataProvider
ModelState	Získá stav modelu po procesu vazby modelu. Tento modelový stav bude před vytvořením vazby modelu prázdný.
ObjectValidator	Získá nebo nastaví IObjectModelValidator.
Request	Získá nebo nastaví zprávu požadavku HTTP.
Url	Získá objekt pro generování adres URL do jiných rozhraní API.
User	Získá nebo nastaví aktuální objekt zabezpečení přidružený k tomuto požadavku.

Metody

BadRequest()	BadRequestResult Vytvoří (400 Chybný požadavek).
BadRequest(ModelStateDictionary)	InvalidModelStateResult Vytvoří (400 Chybný požadavek) se zadaným stavem modelu.
BadRequest(String)	Vytvoří BadRequestErrorMessageResult (400 Chybný požadavek) se zadanou chybovou zprávou.
Conflict()	ConflictResult Vytvoří konflikt (409).
Content<T>(HttpStatusCode, T)	Vytvoří se NegotiatedContentResult<T> zadanými hodnotami.
Created(String, Object)	Vytvoří CreatedResult (201 Vytvořeno) se zadanými hodnotami.
Created(Uri, Object)	Vytvoří CreatedResult (201 Vytvořeno) se zadanými hodnotami.
CreatedAtRoute(String, Object, Object)	Vytvoří CreatedAtRouteResult (201 Vytvořeno) se zadanými hodnotami.
Dispose()	Provede aplikací definované úlohy spojené s uvolněním nebo resetováním nespravovaných prostředků.
Dispose(Boolean)	Uvolní nespravované prostředky, které objekt používá, a volitelně uvolní spravované prostředky.
InternalServerError()	InternalServerErrorResult Vytvoří vnitřní chybu serveru (500).
InternalServerError(Exception)	Vytvoří ExceptionResult (500 Vnitřní chyba serveru) se zadanou výjimkou.
Json<T>(T)	JsonResult Vytvoří (200 OK) se zadanou hodnotou.
Json<T>(T, JsonSerializerSettings)	JsonResult Vytvoří (200 OK) se zadanými hodnotami.
Json<T>(T, JsonSerializerSettings, Encoding)	JsonResult Vytvoří (200 OK) se zadanými hodnotami.
NotFound()	Vytvoří ( NotFoundResult 404 Nenalezena).
Ok()	Vytvoří ( OkResult 200 OK).
Ok<T>(T)	OkObjectResult Vytvoří (200 OK) se zadanými hodnotami.
Redirect(String)	Vytvoří RedirectResult hodnotu (302 Found) se zadanou hodnotou.
Redirect(Uri)	Vytvoří RedirectResult hodnotu (302 Found) se zadanou hodnotou.
RedirectToRoute(String, Object)	Vytvoří RedirectToRouteResult (302 Nalezeno) se zadanými hodnotami.
ResponseMessage(HttpResponseMessage)	Vytvoří se zadanou ResponseMessageResult odpovědí.
StatusCode(HttpStatusCode)	Vytvoří se zadaným StatusCodeResult stavovým kódem.
Validate<TEntity>(TEntity)	Ověří danou entitu a přidá chyby ověření do ModelState prázdné předpony.
Validate<TEntity>(TEntity, String)	Ověří danou entitu a přidá chyby ověření do ModelState.