Преди използвах webapi за предоставяне на интерфейси в проекта и установих, че в проекта има автоматично генериране на помощни документи според методите и коментарите на webapi, а също така можеш да тестваш webapi методи, които са много мощни, и сега ще ги споделя с теб.
Първо разгледай генерираната документация на webapi.
1. Следващата фигура показва горната страница на документа за помощ при генериране, където Values е контролерът, а списъкът под API показва http метода (Get, POST и др.), действието на заявката и описанието на метода.
2. Кликнете върху линка в червеното поле, за да отворите страницата с подробности за API метода, както е показано на фигурата по-долу.
3. Кликнете върху Test API, за да отворите следващата страница
4. Въведете параметрите, натиснете бутона Изпрати, отворете следващата страница и ще видите връщаната стойност.
Стъпките за настройката са следните:
Среда за разработка VS2012 + MVC4 + WEB API
1. Реферирайте Web API тестовия клиент чрез NuGet
Позоваването на DLL ще генерира файл по следния начин:
Това е нашият интерфейс за помощна документация
2. Направете следните настройки в свойствата на проекта, проверете XMl документния файл и задайте пътя
3. Създайте XmlDocument.xml под папката App_Data на проекта
4. Отворете AreasHelpPageApp_StartHelpPageConfig.cs файла и отменете следните коментари с код
Стартирайте проекта, отворете http://localhost:3619/Help и ще видите автоматично генерирания API документ, който е изображение на статията
Изтегляне на проект:
Публикувано в 6.10.2016 г. 15:08:16 ч.
|
|
|
|
