Šis straipsnis yra veidrodinis mašininio vertimo straipsnis, spauskite čia norėdami pereiti prie originalaus straipsnio.

Rodinys: 20232|Atsakyti: 0

[WebAPI] webAPI automatiškai generuoja pagalbos dokumentaciją

[Kopijuoti nuorodą]
Paskelbta 2016-10-06 15:08:16 | | | |
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:

WebAPIHelper.part2.rar (893.15 KB, Atsisiuntimų skaičius: 1) WebAPIHelper.part1.rar (1.5 MB, Atsisiuntimų skaičius: 0)




Ankstesnis:SS-PANEL v3 veikia Python servers.py klaida
Kitą:Blokuoti dešiniuoju pelės mygtuku F12 ir vengti peržiūrėti šaltinio kodą
Atsakomybės apribojimas:
Visa programinė įranga, programavimo medžiaga ar straipsniai, kuriuos skelbia Code Farmer Network, yra skirti tik mokymosi ir mokslinių tyrimų tikslams; Aukščiau nurodytas turinys negali būti naudojamas komerciniais ar neteisėtais tikslais, priešingu atveju vartotojai prisiima visas pasekmes. Šioje svetainėje pateikiama informacija gaunama iš interneto, o ginčai dėl autorių teisių neturi nieko bendra su šia svetaine. Turite visiškai ištrinti aukščiau pateiktą turinį iš savo kompiuterio per 24 valandas nuo atsisiuntimo. Jei jums patinka programa, palaikykite autentišką programinę įrangą, įsigykite registraciją ir gaukite geresnes autentiškas paslaugas. Jei yra kokių nors pažeidimų, susisiekite su mumis el. paštu.

Mail To:help@itsvse.com