Раніше я використовував webAPI для надання інтерфейсів у проєкті і виявив, що в проєкті автоматично генерується довідкові документи відповідно до методів webapi та коментарів, а також можна тестувати методи webapi, які дуже потужні, і тепер я поділюся ними з вами.
Спочатку ознайомтеся з документацією згенерованої веб-API.
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-документ, який є зображенням статті
Завантаження проєкту:
Опубліковано 06.10.2016 15:08:16
|
|
|
|
