ApiResponseType.IsDefaultResponse Propriété

Référence

Définition

Espace de noms:: Microsoft.AspNetCore.Mvc.ApiExplorer

Assembly:: Microsoft.AspNetCore.Mvc.Abstractions.dll

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

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

Paquet:: Microsoft.AspNetCore.App.Ref v3.0.1

Paquet:: Microsoft.AspNetCore.App.Ref v3.1.10

Paquet:: Microsoft.AspNetCore.App.Ref v5.0.0

Paquet:: Microsoft.AspNetCore.App.Ref v6.0.6

Paquet:: Microsoft.AspNetCore.App.Ref v7.0.5

Paquet:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: ApiResponseType.cs

Source:: ApiResponseType.cs

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.

Obtient ou définit une valeur indiquant si le type de réponse représente une réponse par défaut.

public:
 property bool IsDefaultResponse { bool get(); void set(bool value); };

public bool IsDefaultResponse { get; set; }

member this.IsDefaultResponse : bool with get, set

Public Property IsDefaultResponse As Boolean

Valeur de propriété

Boolean

Remarques

Si un ApiDescription a une réponse par défaut, la StatusCode propriété doit être ignorée. Cette réponse sera utilisée lorsqu’un format de réponse plus spécifique ne s’applique pas. L’utilisation courante d’une réponse par défaut consiste à spécifier le format de communication des conditions d’erreur.

S’applique à