Как показать пример в документации по XML? - PullRequest
Новая
       30

Как показать пример в документации по XML?

0 голосов
/ 29 октября 2018

здесь моя модель для регистрации и установки комментариев, например, но она по-прежнему не отображается в чванстве, ее отображение выглядит примерно так { имя_пользователь: «строка» }

вместо { имя_пользователь: "Jasmin" } 

public class RegisterViewModel
    {
        /// <summary>
        /// Name of the user
        /// </summary>
        /// <example>Jasmin</example>
        [Required]
        [Display(Name = "Name")]
        public string UserName { get; set; }

        /// <summary>
        /// User Contact Number
        /// </summary>
        /// <example>9033156314</example>
        [Required]
        [Phone]
        [Display(Name = "PhoneNumber")]
        public string ContactNumber { get; set; }

        /// <summary>
        /// User Device Id
        /// </summary>
        /// <example>12364457tryhret1223</example>
        [Required]
        public string DeviceId { get; set; }

        /// <summary>
        /// User Device Info
        /// </summary>
        /// <example>Jasmin</example>
        [Required]
        public string DeviceInfo { get; set; }
    }

и мой метод ниже 

/// <summary>
        /// Register User Through Contact Number.
        /// </summary>
        [HttpPost]
        [AllowAnonymous]
        public async Task<IActionResult> Register([FromBody]RegisterViewModel model)
        {

}

но пример не показан в чванстве

1 Ответ

0 голосов
/ 29 октября 2018

Тег документации XML * <example> не используется Swashbuckle. Вы должны использовать IOperationalFilter для добавления примеров вручную, так как нет встроенного способа. Тем не менее, кто-то был достаточно хорош, чтобы создать пакет NuGet, который делает его намного проще, метко названный Swashbuckle.Examples. Для проекта ASP.NET Core вам понадобится NuGets Swashbuckle.AspNetCore.Examples или Swashbuckle.AspNetCore.Filters, в зависимости от версии Swashbuckle.AspNetCore, с которой вы работаете.

...