Описание страницы справки WebApi

Ответ 1

В соответствии с этой статьей вы можете использовать комментарии документации XML для создания документации. Чтобы включить эту функцию, откройте файл Areas/HelpPage/App_Start/HelpPageConfig.cs и раскомментируйте следующую строку:

config.SetDocumentationProvider(new XmlDocumentationProvider(
    HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));

Теперь включите документацию XML. В обозревателе решений щелкните правой кнопкой мыши проект и выберите "Свойства". Выберите страницу "Создание".

В разделе "Выход" проверьте файл документации XML. В поле редактирования введите "App_Data/XmlDocument.xml".

Добавьте несколько комментариев к методам контроллера. Например:

/// <summary>
/// Gets some very important data from the server.
/// </summary>
public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

/// <summary>
/// Looks up some data by ID.
/// </summary>
/// <param name="id">The ID of the data.</param>
public string Get(int id)
{
    return "value";
}

Ответ 2

Для просмотра описания необходимо следовать этому:

1. Каждое действие в вашем клиентском контроллере должно иметь документацию XML
2. Откройте свойства проекта, который содержит ваши контроллеры, и включите документирование XML следующим образом:

3. В методе Register для класса HelpPageConfig (Areas/HelpPage/App_Start/HelpPageConfig.cs) раскомментируйте строку 19 и не забудьте изменить путь к файлу следующим образом:

   config.SetDocumentationProvider(new XmlDocumentationProvider(
       HttpContext.Current.Server.MapPath("~/App_Data/MvcApplication4.XML"))
   );
   

Это все, что вы должны сделать. Последнее, что нужно сделать, это включить файл, созданный в App_Data, в ваш проект, чтобы файл был развернут в работе.

Ответ 3

Для тех из вас, кто использует VB.NET, вам, кажется, придется сделать это немного по-другому.

Перейдите на вкладку"Компиляция" (вкладка "Сборка" отсутствует) для проекта Web API, а затем убедитесь, что установлен флажок "Создать файл документации XML".

Выходные данные фактически помещаются в /bin/enjprojectName automotive.xml, поэтому теперь вам нужно изменить вызов SetDocumentationProvider, чтобы он указывал на путь "~/bin/{projectname}.xml"(очевидно, замените {имя_проекта} реальным именем проекта).

Это кажется вонючим, поэтому, пожалуйста, дайте мне знать, если кто-нибудь найдет другой способ сделать это.