Страницы справки WebAPI - Чтение атрибутов контроллера

Question

Я использую проект страниц справки WebAPI из nuget для документирования своих услуг ASP.Net WebAPI.

У меня есть несколько контроллеров, у которых есть атрибут [Авторизовать] и несколько настраиваемых атрибутов.

То, что я не смог достичь, - это добавить атрибуты в документацию.

Таким образом, если контроллер помечается как [Авторизоваться], то документация для контроллера будет сказать что-то вроде «Это контроллер XYZ требует авторизации»

Так что мой вопрос, как я могу изменить код WebAPI помочь, документируйте атрибуты моих контроллеров.

Атрибуты уровня модели работают без проблем.

Answer 1

Для этого можно установить установленный XmlDocumentationProvider.cs на Areas\HelpPage\. Там измените метод GetDocumentation(HttpControllerDescriptor controllerDescriptor). Вы можете проверить любые атрибуты, которые не украшены никаким типом контроллера controllerDescriptor.ControllerType и соответственно сменить документацию.

При обновлении пакета HelpPage NuGet вы можете найти делать выше неудобно, как вы можете перегрузить содержимое с последними битами ... так что вместо этого вы можете создать пользовательские документации, унаследованные от XmlDocumentationProvider и вместо того, чтобы сделать небольшую модификацию установленный файл HelpPageConfig.c и укажите свой заказчик.