Документация страницы справки веб-API ASP.NET с использованием комментариев Xml на контроллерах

Я установил пакет ASP.NET Web Help Страница и хотел бы использовать его для создания документации для моих действий с контроллером API с помощью Xml комментарии уже о них.

Я наткнулся на статью на блоге MSN Yao, где он обсуждает, как документация может быть сгенерирована на основе комментариев XML.

Однако в методе Register HelpPageConfig метод SetDocumentationProvider ожидает экземпляр XmlDocumentationProvider, построенный с физическим путем к файлу документации Xml.

Есть ли другой способ сделать это? Я не понимаю, почему мне нужно указать на файл документации Xml.

Спасибо

Ответы

Ответ 1

XmlDocumentationProvider ищет файл xml (с вашими комментариями кода xml), который генерируется при компиляции вашего проекта. Вы можете включить его, перейдя в свой проект Properties → Build → Output. Здесь установите флажок для файла документации XML.

Ответ 2

Если проблема по-прежнему возникает, см. ниже шаги.

Шаг 1 - добавьте комментарий на уровне контроллера

// GET api/documentation
/// <summary>
/// This is how we create a documentation
/// </summary>
/// <returns></returns>
public IEnumerable<string> Get()

Шаг 2 - Создание свойства Страница "Свойства проекта" и настройте выход xml для документации

введите описание изображения здесь

Шаг 3 - Конфигурация HelpPage

Чтобы настроить HelpPageConfig для использования нашего XML файла документации, перейдите к ~\Areas\HelpPage\HelpPageConfig.cs.

По умолчанию команда config.SetDocumentationProvider закомментирована. Используйте этот оператор и укажите местоположение DocumentationProvider в нашем XML файле:

public static void Register(HttpConfiguration config)
{
   // Uncomment the following to use the documentation from XML documentation file.
   config.SetDocumentationProvider(
            new XmlDocumentationProvider(
                HttpContext.Current.Server.MapPath("~/App_Data/Documentation.xml")));
}

EDIT:

Местоположение HelpPageConfig в новом проекте Web API 2.2, созданного в VS2013, - это ~\Areas\HelpPage\App_Start\HelpPageConfig.cs

Ответ 3

Я знаю, что на этот вопрос ответили, но в случае, если это поможет кому-то Я нашел эту страницу из-за поиска решения для документации для IHttpActionResult

Как добавить IHttpActionResult в документацию