Как реализовать функцию поиска и добавлять комментарии в Swagger

Question

ребята:

Я использую swagger для создания документа api. Я использую ASP.NET WebAPI2 для разработки WebAPI. И я встретил три вопроса:

Во-первых: Как я могу добавить комментарии для контроллера WebAPI? Я стараюсь, чтобы добавить комментарий на контроллер

namespace IMCAPI.Controllers 
{ 
/// <summary> 
/// Value API 
/// </summary> 
[Authorize] 
public class ValuesController : ApiController 
{ 
    // GET api/values 
    /// <summary> 
    /// Get all Values 
    /// </summary> 
    /// <returns></returns> 
    public IEnumerable<string> Get() 
    { 
     return new string[] { "value1", "value2" }; 
    } 

, но not work.

Во-вторых: Как я могу найти конкретный WebAPI в Swagger по адресу brower Url? например, Browser Url Search

Например, если я хочу искать Value API, я ввожу значение в красный раздел, я хочу, чтобы результат поиска просто отображал Value API, я не хочу, чтобы появился другой API (например, Account). Или как установить SwaggerConfig.cs, который может иметь функцию поиска?

В-третьих: Я хочу знать, мог ли swagger просто прочитать один XML-файл? Я поиск в Интернете, они демо, как этот

private static string GetXmlCommentsPath() 
    { 
     return String.Format("{0}/App_Data/IMCAPI.XML", AppDomain.CurrentDomain.BaseDirectory); 
    } 

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

это. Надеюсь, кто-то может мне помочь. Спасибо!

Answer 1

Ваш первый вопрос: Комментарии являются появляться, вы положили их на методе Get в коде, они появляются на методе Get в скриншоте. Если вы хотите описать всю услугу, то Swagger documentation говорит, что используется метод Description.

Ваш второй: вы не можете показать все методы этого API.

В-третьих: Swagger documentation говорит, что вы звоните IncludeXmlComments несколько раз с указанием пути к каждому XML.