Varem kasutasin webAPI-d projektis liideste pakkumiseks ja avastasin, et projektis genereeritakse automaatselt abidokumente vastavalt webapi meetoditele ja kommentaaridele, ning saad testida ka webapi meetodeid, mis on väga võimsad, ja nüüd jagan neid teiega.
Vaata esmalt genereeritud webapi dokumentatsiooni.
1. Järgmine joonis näitab genereerimise abidokumendi ülemist lehte, kus Väärtused on kontroller, ja API all olev nimekiri näitab http meetodit (Get, POST jne), päringu tegevust ja meetodi kirjeldust.
2. Klõpsa punases kastis oleval lingil, et avada API meetodi detailide leht, nagu alloleval joonisel näidatud.
3. Klõpsa Test API, et avada järgmine leht
4. Sisesta parameetrid, klõpsa nuppu Saada, ava järgmine leht ja näed tagastusväärtust.
Selle seadistamise sammud on järgmised:
Arenduskeskkond VS2012 + MVC4 + WEB API
1. Viidata veebipõhisele API testikliendile NuGeti kaudu
DLL-ile viidates genereeritakse selline fail:
See on meie abidokumentatsiooni liides
2. Tee projekti omadustes järgmised seaded, kontrolli XMl dokumendifaili ja määra tee
3. Loo XmlDocument.xml projekti App_Data kausta alla
4. Ava AreasHelpPageApp_StartHelpPageConfig.cs fail ja tühista järgmised koodikommentaarid
Käivita projekt, ava http://localhost:3619/Help ja näed automaatselt genereeritud API dokumenti, mis on artikli pilt
Projekti allalaadimine: