See artikkel on masintõlke peegelartikkel, palun klõpsake siia, et hüpata algse artikli juurde.

Vaade: 20232|Vastuse: 0

[WebAPI] webAPI genereerib automaatselt abidokumentatsiooni

[Kopeeri link]
Postitatud 06.10.2016 15:08:16 | | | |
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:

WebAPIHelper.part2.rar (893.15 KB, Allalaadimiste arv: 1) WebAPIHelper.part1.rar (1.5 MB, Allalaadimiste arv: 0)




Eelmine:SS-Panel v3 käivitab Python servers.py viga
Järgmine:Blokeeri paremklõps F12 ja väldi lähtekoodi vaatamist
Disclaimer:
Kõik Code Farmer Networki poolt avaldatud tarkvara, programmeerimismaterjalid või artiklid on mõeldud ainult õppimiseks ja uurimistööks; Ülaltoodud sisu ei tohi kasutada ärilistel ega ebaseaduslikel eesmärkidel, vastasel juhul kannavad kasutajad kõik tagajärjed. Selle saidi info pärineb internetist ning autoriõiguste vaidlused ei ole selle saidiga seotud. Ülaltoodud sisu tuleb oma arvutist täielikult kustutada 24 tunni jooksul pärast allalaadimist. Kui sulle programm meeldib, palun toeta originaaltarkvara, osta registreerimist ja saa paremaid ehtsaid teenuseid. Kui esineb rikkumist, palun võtke meiega ühendust e-posti teel.

Mail To:help@itsvse.com