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

Вид: 20232|Ответ: 0

[WebAPI] webAPI автоматически генерирует документацию по справке

[Скопировать ссылку]
Опубликовано 06.10.2016 15:08:16 | | | |
Ранее я использовал webAPI для предоставления интерфейсов в проекте и обнаружил, что в проекте автоматически генерируется документы поддержки по методам webAPI и комментариям, а также можно протестировать методы webapi, которые очень мощны, и теперь я поделюсь ими с вами.
Сначала посмотрите документацию по сгенерированному веб-API.
1. Следующая иллюстрация показывает верхнюю страницу документа помощи генерации, где Values — контроллер, а список под API показывает http-метод (Get, POST и др.), действие запроса и описание метода.
2. Нажмите на ссылку в красном окне, чтобы открыть страницу с деталями метода API, как показано на рисунке ниже.
3. Нажмите Test API, чтобы открыть следующую страницу

4. Введите параметры, нажмите кнопку «Отправить», откройте следующую страницу, и вы увидите возвращаемое значение.

Шаги для его настройки следующие:
Среда разработки VS2012 + MVC4 + WEB API
1. Обратиться к клиенту тестирования веб-API через NuGet

Ссылка на DLL сгенерирует такой файл:
Это наш интерфейс справочной документации


2. Сделайте следующие настройки в свойствах проекта, проверьте файл XMl и задайте путь
3. Создайте XmlDocument.xml в папке App_Data проекта
4. Откройте файл AreasHelpPageApp_StartHelpPageConfig.cs и отмените следующие комментарии по коду

Запустите проект, откройте http://localhost:3619/Help, и вы увидите автоматически сгенерированный API-документ — изображение статьи

Загрузка проекта:

WebAPIHelper.part2.rar (893.15 KB, Количество скачиваний: 1) WebAPIHelper.part1.rar (1.5 MB, Количество скачиваний: 0)




Предыдущий:Ошибка SS-Panel V3 с Python servers.py
Следующий:Заблокируйте правый клик, F12, и избегайте просмотра исходного кода
Отказ:
Всё программное обеспечение, программные материалы или статьи, публикуемые Code Farmer Network, предназначены исключительно для учебных и исследовательских целей; Вышеуказанный контент не должен использоваться в коммерческих или незаконных целях, иначе пользователи несут все последствия. Информация на этом сайте взята из Интернета, и споры по авторским правам не имеют отношения к этому сайту. Вы должны полностью удалить вышеуказанный контент с компьютера в течение 24 часов после загрузки. Если вам нравится программа, пожалуйста, поддержите подлинное программное обеспечение, купите регистрацию и получите лучшие подлинные услуги. Если есть нарушение, пожалуйста, свяжитесь с нами по электронной почте.

Mail To:help@itsvse.com