Anksčiau naudojau webapi, kad pateikčiau sąsajas projekte, ir pastebėjau, kad projekte yra automatinis pagalbos dokumentų generavimas pagal webapi metodus ir komentarus, taip pat galite išbandyti webapi metodus, kurie yra labai galingi, ir dabar pasidalinsiu jais su jumis.
Pirmiausia peržiūrėkite sugeneruotą webapi dokumentaciją.
1. Šiame paveikslėlyje parodytas viršutinis generavimo pagalbos dokumento puslapis, kuriame reikšmės yra valdiklis, o sąraše po API rodomas http metodas (Get, POST ir kt.), užklausos veiksmas ir metodo aprašymas.
2. Spustelėkite nuorodą raudoname laukelyje, kad atidarytumėte API metodo išsamios informacijos puslapį, kaip parodyta paveikslėlyje žemiau.
3. Spustelėkite Testuoti API, kad atidarytumėte šį puslapį
4. Įveskite parametrus, spustelėkite mygtuką Siųsti, atidarykite šį puslapį ir pamatysite grąžinamą vertę.
Jo nustatymo veiksmai yra šie:
Kūrimo aplinka VS2012 + MVC4 + WEB API
1. Nuoroda į žiniatinklio API testavimo klientą per NuGet
Nuoroda į DLL sugeneruos tokį failą:
Tai mūsų pagalbos dokumentacijos sąsaja
2. Projekto ypatybėse atlikite šiuos nustatymus, patikrinkite XMl dokumento failą ir nustatykite kelią
3. Sukurkite XmlDocument.xml projekto App_Data aplanke
4. Atidarykite AreasHelpPageApp_StartHelpPageConfig.cs failą ir atšaukite šiuos kodo komentarus
Paleiskite projektą, atidarykite http://localhost:3619/Help ir pamatysite automatiškai sugeneruotą API dokumentą, kuris yra straipsnio vaizdas
Projekto atsisiuntimas: