ApiController Classe

Référence

Définition

Espace de noms:: System.Web.Http

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

Assembly:: System.Web.Http.dll

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

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

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

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

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

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Définit des propriétés et des méthodes pour un contrôleur d'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

Héritage: Object
ApiController

Attributs: ControllerAttribute UseWebApiActionConventionsAttribute UseWebApiOverloadingAttribute UseWebApiParameterConventionsAttribute UseWebApiRoutesAttribute

Implémente: IDisposable

Constructeurs

ApiController()

Définit des propriétés et des méthodes pour un contrôleur d'API.

Propriétés

ActionContext	Obtient ActionContext.
Context	Obtient le contexte http.
ControllerContext	Obtient ou définit ControllerContext.
MetadataProvider	Obtient IModelMetadataProvider.
ModelState	Obtient l'état du modèle après le processus de liaison de données. Ce ModelState sera vide avant la liaison de données.
ObjectValidator	Obtient ou définit IObjectModelValidator.
Request	Obtient ou définit le message de requête HTTP.
Url	Obtient une fabrique utilisée pour générer des URL vers d’autres API.
User	Obtient ou définit le principal actuel associé à cette requête.

Méthodes

BadRequest()	Crée une BadRequestResult (requête incorrecte 400).
BadRequest(ModelStateDictionary)	Crée une InvalidModelStateResult (requête incorrecte 400) avec l’état de modèle spécifié.
BadRequest(String)	Crée une BadRequestErrorMessageResult (demande incorrecte 400) avec le message d’erreur spécifié.
Conflict()	Crée un ConflictResult (conflit 409).
Content<T>(HttpStatusCode, T)	Crée un NegotiatedContentResult<T> avec les valeurs spécifiées.
Created(String, Object)	Crée un CreatedResult (201 Créé) avec les valeurs spécifiées.
Created(Uri, Object)	Crée un CreatedResult (201 Créé) avec les valeurs spécifiées.
CreatedAtRoute(String, Object, Object)	Crée un CreatedAtRouteResult (201 Créé) avec les valeurs spécifiées.
Dispose()	Exécute les tâches définies par l'application associées à la libération ou à la redéfinition des ressources non managées.
Dispose(Boolean)	Libère les ressources non managées utilisées par l'objet et libère éventuellement les ressources managées.
InternalServerError()	Crée un InternalServerErrorResult (erreur de serveur interne 500).
InternalServerError(Exception)	Crée une ExceptionResult (erreur de serveur interne 500) avec l’exception spécifiée.
Json<T>(T)	Crée un JsonResult (200 OK) avec la valeur spécifiée.
Json<T>(T, JsonSerializerSettings)	Crée un JsonResult (200 OK) avec les valeurs spécifiées.
Json<T>(T, JsonSerializerSettings, Encoding)	Crée un JsonResult (200 OK) avec les valeurs spécifiées.
NotFound()	Crée un NotFoundResult (404 introuvable).
Ok()	Crée un OkResult (200 OK).
Ok<T>(T)	Crée un OkObjectResult (200 OK) avec les valeurs spécifiées.
Redirect(String)	Crée un RedirectResult (302 trouvé) avec la valeur spécifiée.
Redirect(Uri)	Crée un RedirectResult (302 trouvé) avec la valeur spécifiée.
RedirectToRoute(String, Object)	Crée un RedirectToRouteResult (302 trouvé) avec les valeurs spécifiées.
ResponseMessage(HttpResponseMessage)	Crée un ResponseMessageResult avec la réponse spécifiée.
StatusCode(HttpStatusCode)	Crée un StatusCodeResult avec le code status spécifié.
Validate<TEntity>(TEntity)	Valide l’entité donnée et ajoute les erreurs de validation au ModelState sous un préfixe vide.
Validate<TEntity>(TEntity, String)	Valide l’entité donnée et ajoute les erreurs de validation à .ModelState

S’applique à