Описание тега asp.net-web-api-helppages

Страница справки веб-API ASP.NET автоматически создает содержимое страницы справки для веб-API на вашем сайте.
1 ответ

Страница справки asp.net не показывает правильные маршруты

Я использую атрибуты маршрутов для маршрутизации действий в контроллерах, но asp.net генерирует неправильную страницу справки [HttpGet] [Route("getAll")] [AllowAnonymous] public IHttpActionResult GetCategories(){...} Но результат
2 ответа

Инструменты документации Asp.Net Web API для поддержки редактирования описания

Я ищу инструмент документации или генератор для приложения веб-API asp.net. Инструмент должен позволять редактировать описание / сводку методов или параметров API. Мне может понадобиться это, чтобы позволить различным командам, например, PM, QA, так…
6 ответов

Как обработать путь на лазури для XmlDocumentationProvider

Я использую Azure для развертывания моих новых веб-API, я новичок в развертывании на IIS и Azure. Я добавил свои веб-API на Azure как веб-приложение, и оно работает нормально, пока я не добавил документацию для функций каждого API. После добавления …
2 ответа

Страницы справки Web API и API Explorer возвращают 0 описаний

У меня есть этот проект, который просто проект веб-API. В какой-то момент в прошлом я удалил HelpPages и заставил приложение использовать OWIN. Теперь меня попросили добавить API HelpPages обратно, в котором я это сделал. Я установил мой класс запус…
1 ответ

WebAPI - автоматически генерировать документацию со всеми возможными ответами

Я прочитал статью http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/creating-api-help-pages и она отлично работает. Но я бы предпочел добавить все возможные ответы и условия, когда эти ответы будут отправлены. Любой инструмент …
1 ответ

Документирование описаний сложных типов

В моем API я пытаюсь задокументировать описания различных полей, однако ни один из атрибутов не работает. Я знаю, что эта функциональность, как предполагается, была недавно реализована в WebAPI 5.1 (работает WebAPI.HelpPage 5.1.2). Страницы справки …
1 ответ

Дублирование страницы справки Web API Действие для всех областей

Я работаю с Web API 2, и он, кажется, уже подтягивает мои существующие вызовы API, за исключением того, что он дублирует все вызовы для каждой области, которая у меня есть. Например, скажем, у меня есть 3 области, и в одной из них у меня есть вызов …
1 ответ

Страницы справки WebAPI не отображают все конечные точки для контроллера OData

Я добавил компонент Справочные страницы для моего веб-API ASP.NET MVC с OData. Чтобы это работало, мне нужно было явно указать [ApiExplorerSetting(IgnoreAPI = false)]. Однако он показывает только конечную точку GET по умолчанию, например: api/Custom…
1 ответ

Как заставить WebApi HelpPage распознавать документацию модели, расположенную вне самого проекта WebApi

Допустим, у меня есть два проекта в одном решении WebApi: проект WebApi, который предоставляет точки доступа для всех служб API Core: библиотечный проект, в котором определена бизнес-логика, включая модель системы. Для каждого запроса WebApi он испо…
2 ответа

Страница справки WebAPI - Документация для свойств возврата или модели параметров / класса

Я использую страницу справки Web API с Web API 2 (5.0) - оба последних пакета Nuget. Мне бы хотелось, чтобы в справочной документации отображались комментарии к свойствам классов, которые являются параметрами или возвращаются в теле HttpResponseMess…
1 ответ

Поместите документацию Web Api позади страницы входа, чтобы только действительный пользователь мог просматривать справочную документацию Web Api.

Мы создали проект веб-API, в котором мы использовали обычную аутентификацию. Мы использовали пакет nuget для создания справочной документации по Web Api, поэтому он добавил новую область, контроллер и представления для справки Web Api. Мы разместили…
1 ответ

Страницы справки ASP Web API - ссылки на другие страницы

Я использую страницы справки Web API, и я хотел бы иметь возможность включать ссылки на другие методы. Я видел из-за того, что теги документации XML не обрабатываются страницами справки Web API 2? что использование не поддерживается. Есть ли какие-л…
4 ответа

Страница справки Web Api XML комментарии из более чем 1 файлов

У меня есть разные плагины в моем проекте Web API с их собственными документами XML, и у меня есть одна централизованная страница справки, но проблема в том, что страница справки Web Api по умолчанию поддерживает только один файл документации new Xm…
0 ответов

Экспорт Microsoft.AspNet.WebApi.HelpPage

Я использую пакет nuget Microsoft.AspNet.WebApi.HelpPage в VS2012. Мне интересно, есть ли возможность экспорта для создания.chm/word/pdf/etc Благодарю. Гильермо.
1 ответ

Настройка раздела "Описание ресурса" страницы справки ASP.NET Web API

Я использую ASP.NET Web API, и он удобно автоматически генерирует документацию для моего API, но некоторые из них не имеют смысла. Возьмите скриншот ниже в качестве примера. Это конечная точка GET пользователя по его идентификатору, а в Resource Des…
1 ответ

Страница справки Web API с сообщением "Элемент с таким же ключом уже добавлен"

Я только что обновил страницу справки по веб-API до версии 2.1. Когда я попытался открыть страницу справки, я получил эту ошибку: [ArgumentException: An item with the same key has already been added.] System.ThrowHelper.ThrowArgumentException(Except…
2 ответа

Как отобразить только методы, принадлежащие контроллеру, указанному в URL

Я работаю над настройкой страниц справки ASP.NET Web API. Я ищу лучший подход для отображения методов, которые принадлежат контроллеру, указанному в URL. Все мои контроллеры имеют префикс "ws_". Я добавил запись в свой RouteConfig для распознавания …
3 ответа

Пользовательская дополнительная информация в документации API

Я прочитал здесь о дополнительной информации о странице справки веб-API. Аннотация данных фактически предоставляет дополнительную информацию для документации. Но я хочу знать, что в любом случае можно предоставить дополнительную информацию без анно…
2 ответа

Страница помощи Web Api - не избегайте HTML в документации XML

Я использую документацию XML для моей справочной страницы ASP.NET Web API, как показано здесь. Я хотел бы знать, есть ли способ включить html в комментарии так, чтобы он отображался на веб-странице, а не удалялся / игнорировался / экранировался.В ча…
1 ответ

Страница справки Web Api - все <see cref = "MyClass" /> отсутствуют

В документации по исходному коду я часто использую: Get a &lt;see cref="Quote"/&gt; for the specified &lt;see cref="apiOrder"/&gt; object. И это красиво переводится в строку ниже в файле XmlDocument.xml, который содержит скомпилированные страницы сп…