Пример ответа пользовательского интерфейса Swagger Asp.Net Основной веб-Api

#c# #asp.net-web-api #swagger-ui #swagger-net

#c# #asp.net-web-api #swagger-пользовательский интерфейс #swagger-net

Вопрос:

Я использую Swagger.AspNetCore для документирования моего api. До сих пор я был рад использовать комментарии xml для генерации примеров модели ответа, пока не дойду до того момента, когда мне нужно будет документировать внедренный объект.

Итак, у меня простая модель:

 public class SummaryResult
{
    /// <summary>Total Cost.</summary>
    /// <value>Total Cost.</value>
    /// <example>6433.2</example>
    public double TotalCost { get; set; }

    /// <summary>Owner.</summary>
    public Owner Owner { get; set; }
}

public class Owner
{
    /// <summary>Owner Name.</summary>
    /// <value>Owner Name.</value>
    /// <example>Michael</example>
    public string Name { get; set; }
}
 

И пользовательский интерфейс Swagger документирует его только для TotalCost, свойство Owner просто пропустило все, что я делаю. Кто-нибудь знает, почему это может произойти? И как это исправить.
Я знаю, как работать со списком — просто добавьте сверху комментарий xml <list></list> , но это не мой случай.

Спасибо

Ответ №1:

Я только что протестировал это, и с моей стороны это нормально:
http://swagger-net-test.azurewebsites.net/swagger/ui/index#/ActionFilter/ActionFilter_Get

Вот как это выглядит на вкладке модели:

1

Как вы можете видеть на изображении, он показывает сводку и примерное значение.

Вот код:
https://github.com/heldersepu/Swagger-Net-Test/blob/master/Swagger_Test/Controllers/ActionFilterController.cs#L29

Обоснованное предположение, что может быть что-то еще, удаляющее эти элементы.