Paramètre du modèle Description dans XMLCOMMENTS

J'utilise Swashbuckle 5.5.3 et la documentation API personnalisée en utilisant XMLComments. J'ai mis la description des propriétés du modèle qui n'est pas éditée dans la documentation de l'API.Paramètre du modèle Description dans XMLCOMMENTS

Exemple de code:

/// <summary> 
/// SomeDetails. 
/// </summary> 
/// <param name="Model">SomeDetails.</param> 
/// <param name="Model.UserName">SomeDetails of username.</param> 
/// <param name="Model.OwnerId">SomeDetails.</param>

Il contient un résumé que je mets au-dessus, mais ne montre pas les détails de la propriété du modèle.

Source

2016-11-24 Uzair Xlade

Quelles sont params de votre action? Sur la capture d'écran, je vois deux paramètres: userName et ownerId et je ne vois aucun objet "Model" que vous décrivez. –

MethodName ([FromUri (Name = "")] ModelName model) C'est pourquoi vous ne voyez pas de modèle. –

Si vous utilisez l'objet modèle comme entrée, la description sera extraite de la documentation fournie dans les propriétés (comme UserName, OwnerId, etc.) de la classe ModelName –

Comme indiqué dans SwashBuckle documentation, vous devez mettre votre description de paramètre sur propriétés eux-mêmes, pas comme paramètres sur les méthodes.

Dans votre cas, cela signifie avoir un modèle comme celui-ci:

public class Model 
{ 
    /// <summary> 
    /// user Name (e.g. ...) 
    /// </summary> 
    public string UserName { get; set; } 

    /// <summary> 
    /// Id of the owner in context of... 
    /// </summary> 
    public int OwnerId { get; set; } 
}

Source

2016-11-25 07:55:00 bsoulier

Paramètre du modèle Description dans XMLCOMMENTS

Répondre

Questions connexes