ApiController Klasse

Referenz

Definition

Namespace:: System.Web.Http

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

Assembly:: System.Web.Http.dll

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

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

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

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

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

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Definiert Eigenschaften und Methoden für API-Controller.

[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

Vererbung: Object
ApiController

Attribute: ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Implementiert: IDisposable

Konstruktoren

ApiController()

Definiert Eigenschaften und Methoden für API-Controller.

Eigenschaften

ActionContext	Ruft das ActionContext ab.
Context	Ruft den HTTP-Kontext ab.
ControllerContext	Ruft den ControllerContext ab oder legt diesen fest.
MetadataProvider	Ruft das IModelMetadataProvider ab.
ModelState	Ruft den Modellstatus nach dem Modellbindungsprozess ab. Dieser Modellzustand ist leer, bevor die Modellbindung erfolgt.
ObjectValidator	Ruft den IObjectModelValidator ab oder legt diesen fest.
Request	Ruft die HTTP-Anforderungsnachricht ab oder legt sie fest.
Url	Ruft eine Factory ab, die zum Generieren von URLs für andere APIs verwendet wird.
User	Ruft den aktuellen Prinzipal ab, der dieser Anforderung zugeordnet ist, oder legt diesen fest.

Methoden

BadRequest()	Erstellt eine BadRequestResult (400 ungültige Anforderung).
BadRequest(ModelStateDictionary)	Erstellt eine InvalidModelStateResult (400 ungültige Anforderung) mit dem angegebenen Modellstatus.
BadRequest(String)	Erstellt eine BadRequestErrorMessageResult (400 Ungültige Anforderung) mit der angegebenen Fehlermeldung.
Conflict()	Erstellt einen ConflictResult (409-Konflikt).
Content<T>(HttpStatusCode, T)	Erstellt eine NegotiatedContentResult<T> mit den angegebenen Werten.
Created(String, Object)	Erstellt eine CreatedResult (201 Erstellt) mit den angegebenen Werten.
Created(Uri, Object)	Erstellt eine CreatedResult (201 Erstellt) mit den angegebenen Werten.
CreatedAtRoute(String, Object, Object)	Erstellt eine CreatedAtRouteResult (201 Erstellt) mit den angegebenen Werten.
Dispose()	Führt anwendungsspezifische Aufgaben durch, die mit der Freigabe, der Zurückgabe oder dem Zurücksetzen von nicht verwalteten Ressourcen zusammenhängen.
Dispose(Boolean)	Gibt die von dem Objekt verwendeten nicht verwalteten Ressourcen und optional auch die verwalteten Ressourcen frei.
InternalServerError()	Erstellt einen InternalServerErrorResult (500 internen Serverfehler).
InternalServerError(Exception)	Erstellt einen ExceptionResult (500 internen Serverfehler) mit der angegebenen Ausnahme.
Json<T>(T)	Erstellt eine JsonResult (200 OK) mit dem angegebenen Wert.
Json<T>(T, JsonSerializerSettings)	Erstellt eine JsonResult (200 OK) mit den angegebenen Werten.
Json<T>(T, JsonSerializerSettings, Encoding)	Erstellt eine JsonResult (200 OK) mit den angegebenen Werten.
NotFound()	Erstellt eine NotFoundResult (404 Nicht gefunden).
Ok()	Erstellt eine OkResult (200 OK).
Ok<T>(T)	Erstellt eine OkObjectResult (200 OK) mit den angegebenen Werten.
Redirect(String)	Erstellt einen RedirectResult (302 Gefunden) mit dem angegebenen Wert.
Redirect(Uri)	Erstellt einen RedirectResult (302 Gefunden) mit dem angegebenen Wert.
RedirectToRoute(String, Object)	Erstellt ein RedirectToRouteResult (302 Found) mit den angegebenen Werten.
ResponseMessage(HttpResponseMessage)	Erstellt eine ResponseMessageResult mit der angegebenen Antwort.
StatusCode(HttpStatusCode)	Erstellt eine StatusCodeResult mit dem angegebenen status Code.
Validate<TEntity>(TEntity)	Überprüft die angegebene Entität und fügt die Validierungsfehler unter einem leeren Präfix hinzu ModelState .
Validate<TEntity>(TEntity, String)	Überprüft die angegebene Entität und fügt die Validierungsfehler zu hinzu ModelState.

Gilt für: