Добавление комментариев к конечным точкам с Swagger

Question

Я использую Swagger / Swashbuckle для своего API. Я хочу, чтобы интерфейс Swagger отображал описания методов. В их документах говорится:

---

2 - Настройте Swashbuckle для включения XML комментариев к файлу в сгенерированный Swagger JSON:

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1",
        new Info
        {
            Title = "My API - V1",
            Version = "v1"
        }
     );

     var filePath = Path.Combine(System.AppContext.BaseDirectory, "MyApi.xml");
     c.IncludeXmlComments(filePath);
}

---

Может кто-нибудь объяснить это? Что я должен делать с этим кодом? Копировать и вставить это куда-нибудь? Если да, то где?

(. NET Framework 4.7)

РЕДАКТИРОВАТЬ:

Ответ Джавада ниже привел меня к решению. В исходном файле SwaggerConfig.cs было следующее:

// If you annotate Controllers and API Types with
// Xml comments (http://msdn.microsoft.com/en-us/library/b2s063f7(v=vs.110).aspx), you can incorporate
// those comments into the generated docs and UI. You can enable this by providing the path to one or
// more Xml comment files.
//
//c.IncludeXmlComments(GetXmlCommentsPath());

Мне было неясно, как изменить эту последнюю строку, чтобы добавить мой XML файл. Это сработало:

c.IncludeXmlComments(Path.Combine(System.AppContext.BaseDirectory, "bin\\KGC.API.xml"));

Мне также пришлось добавить using System.IO.

Answer 1

Я сделал это путем обновления файла SwaggerConfig.cs ..

    public static void Register()
    {
        var thisAssembly = typeof(SwaggerConfig).Assembly;

        GlobalConfiguration.Configuration
            .EnableSwagger("docs/{apiVersion}", c =>
            {
                c.SingleApiVersion("v1", "Title Of API");
                c.Schemes(new List<string> { "http", "https" });
                c.UseFullTypeNameInSchemaIds();
                c.IncludeXmlComments(Path.Combine(System.AppContext.BaseDirectory, "MyApi.xml"));
            });
    }

Последняя строка в приведенном выше коде включила тегирование XML комментариев.

Еще один все, что вам нужно сделать, это

1. Go к свойствам проекта (не решение)
2. Построение / вывод -> Добавить путь к XML Файл документации.

Для справочных целей этот был весьма полезен.