Добавление информации о модели к выводу чванства

Question

Есть ли способ добавить информацию о модели, например, действительные значения, значения по умолчанию, сводку и другие замечания в вывод сваггера?

Например, в C#, как бы я добавил следующие комментарии и атрибуты в Swagger?

/// <summary>
/// A clear summary
/// </summary>
/// <remarks>
/// Some remarks
/// </remarks>
public class A
{
    public A()
    {
        _Field_A = 0;
        _Field_B = string.Empty;
    }

    private int _Field_A { get; set; }

    [Range(0, 150)]
    public int Field_A
    {
        get
        {
            return _Field_A;
        }

        set
        {
            if (value != null) { _Field_A = value; }
        }
    }

    private string _Field_B { get; set; }

    /// <summary>
    /// Field_B summary
    /// </summary>    
    public string Field_B
    {
        get
        {
            return _Field_B;
        }

        set
        {
            if (value != null) { _Field_B = value; }
        }
    }
}

Answer 1

Вам нужно будет включить создание файла документации XML в свойствах вашего проекта: Свойства проекта> Построение> Установите флажок Файл документации XML

Затем вы можете раскомментировать или добавить следующую строку в файл SwaggerConfig.cs:c.IncludeXmlComments(GetXmlCommentsPath());

Answer 2

Согласно github Swashbuckle, вы можете включить комментарии XML, которые позволят вам добавлять метаданные соответственно.

httpConfiguration
    .EnableSwagger(c =>
        {
            c.SingleApiVersion("v1", "A title for your API");
            c.IncludeXmlComments(GetXmlCommentsPathForControllers());
            c.IncludeXmlComments(GetXmlCommentsPathForModels());
        });