Ранее я использовал 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-документ — изображение статьи
Загрузка проекта: