ApiParameterDescription.IsRequired Propriedade

  • Referência

Definição

Namespace:
Microsoft.AspNetCore.Mvc.ApiExplorer
Assembly:
Microsoft.AspNetCore.Mvc.Abstractions.dll
Pacote:
Microsoft.AspNetCore.Mvc.Abstractions v2.2.0
Pacote:
Microsoft.AspNetCore.App.Ref v3.0.1
Pacote:
Microsoft.AspNetCore.App.Ref v3.1.10
Pacote:
Microsoft.AspNetCore.App.Ref v5.0.0
Pacote:
Microsoft.AspNetCore.App.Ref v6.0.6
Pacote:
Microsoft.AspNetCore.App.Ref v7.0.5
Pacote:
Microsoft.AspNetCore.App.Ref v8.0.0
Pacote:
Microsoft.AspNetCore.App.Ref v9.0.0-preview.6.24328.4
Origem:
ApiParameterDescription.cs
Origem:
ApiParameterDescription.cs

Obtém ou define um valor que determina se o parâmetro é necessário.

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

Valor da propriedade

Boolean

Comentários

Um parâmetro será considerado necessário se

  • ele está associado do corpo da solicitação (Body).
  • é um valor de rota necessário.
  • ele tem anotações (por exemplo, BindRequiredAttribute) que indicam que ela é necessária.

Aplica-se a