ApiParameterDescription.IsRequired 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.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:: ApiParameterDescription.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 qui détermine si le paramètre est requis.

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

public bool IsRequired { get; set; }

member this.IsRequired : bool with get, set

Public Property IsRequired As Boolean

Valeur de propriété

Boolean

Remarques

Un paramètre est considéré comme obligatoire si

il est lié à partir du corps de la demande (Body).
il s’agit d’une valeur de route obligatoire.
il a des annotations (par exemple, BindRequiredAttribute) qui indiquent qu’il est nécessaire.

S’applique à