ApiController Klasa

Definicja

Przestrzeń nazw:

System.Web.Http

Zestaw:

Microsoft.AspNetCore.Mvc.WebApiCompatShim.dll

Pakiet:

Microsoft.AspNetCore.Mvc.WebApiCompatShim v2.2.0

Źródło:

ApiController.cs

Definiuje właściwości i metody kontrolera interfejsu 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

Dziedziczenie

Object

ApiController

Atrybuty

ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Implementuje

IDisposable

Konstruktory

ApiController()

Definiuje właściwości i metody kontrolera interfejsu API.

Właściwości

ActionContext	Pobiera klasę ActionContext.
Context	Pobiera kontekst http.
ControllerContext	Pobiera lub ustawia wartość ControllerContext.
MetadataProvider	Pobiera klasę IModelMetadataProvider.
ModelState	Pobiera stan modelu po procesie powiązania modelu. Ten parametr ModelState będzie pusty przed wykonaniem powiązania modelu.
ObjectValidator	Pobiera lub ustawia wartość IObjectModelValidator.
Request	Pobiera lub ustawia komunikat żądania HTTP.
Url	Pobiera fabrykę używaną do generowania adresów URL do innych interfejsów API.
User	Pobiera lub ustawia bieżącą jednostkę skojarzą z tym żądaniem.

Metody

BadRequest()	Tworzy element BadRequestResult (400 Nieprawidłowe żądanie).
BadRequest(ModelStateDictionary)	InvalidModelStateResult Tworzy (400 Nieprawidłowe żądanie) o określonym stanie modelu.
BadRequest(String)	BadRequestErrorMessageResult Tworzy (400 Nieprawidłowe żądanie) z określonym komunikatem o błędzie.
Conflict()	Tworzy element ConflictResult (konflikt 409).
Content<T>(HttpStatusCode, T)	Tworzy element NegotiatedContentResult<T> z określonymi wartościami.
Created(String, Object)	Tworzy element CreatedResult (201 Utworzony) z określonymi wartościami.
Created(Uri, Object)	Tworzy element CreatedResult (201 Utworzony) z określonymi wartościami.
CreatedAtRoute(String, Object, Object)	Tworzy element CreatedAtRouteResult (201 Utworzony) z określonymi wartościami.
Dispose()	Wykonuje zdefiniowane przez aplikację zadania skojarzone ze zwalnianiem lub resetowaniem zasobów niezarządzanych.
Dispose(Boolean)	Zwalnia niezarządzane zasoby, które są używane przez obiekt, a opcjonalnie zwalnia zarządzane zasoby.
InternalServerError()	Tworzy błąd InternalServerErrorResult (500 wewnętrzny błąd serwera).
InternalServerError(Exception)	Tworzy błąd ExceptionResult (500 Wewnętrzny błąd serwera) z określonym wyjątkiem.
Json<T>(T)	Tworzy element JsonResult (200 OK) z określoną wartością.
Json<T>(T, JsonSerializerSettings)	Tworzy element JsonResult (200 OK) z określonymi wartościami.
Json<T>(T, JsonSerializerSettings, Encoding)	Tworzy element JsonResult (200 OK) z określonymi wartościami.
NotFound()	Tworzy element NotFoundResult (404 Nie znaleziono).
Ok()	Tworzy obiekt OkResult (200 OK).
Ok<T>(T)	Tworzy element OkObjectResult (200 OK) z określonymi wartościami.
Redirect(String)	Tworzy element RedirectResult (302 Found) z określoną wartością.
Redirect(Uri)	Tworzy element RedirectResult (302 Found) z określoną wartością.
RedirectToRoute(String, Object)	Tworzy element RedirectToRouteResult (302 Found) z określonymi wartościami.
ResponseMessage(HttpResponseMessage)	Tworzy element ResponseMessageResult z określoną odpowiedzią.
StatusCode(HttpStatusCode)	Tworzy obiekt StatusCodeResult z określonym kodem stanu.
Validate<TEntity>(TEntity)	Weryfikuje daną jednostkę i dodaje błędy walidacji do ModelState pustego prefiksu.
Validate<TEntity>(TEntity, String)	Weryfikuje daną jednostkę i dodaje błędy walidacji do elementu ModelState.