Šis raksts ir mašīntulkošanas spoguļraksts, lūdzu, noklikšķiniet šeit, lai pārietu uz oriģinālo rakstu.

Skats: 20232|Atbildi: 0

[Tīmekļa API] webAPI automātiski ģenerē palīdzības dokumentāciju

[Kopēt saiti]
Publicēts 06.10.2016 15:08:16 | | | |
Agrāk es izmantoju webapi, lai nodrošinātu saskarnes projektā, un atklāju, ka projektā ir automātiska palīdzības dokumentu ģenerēšana saskaņā ar webapi metodēm un komentāriem, un jūs varat arī pārbaudīt webapi metodes, kas ir ļoti spēcīgas, un tagad es dalīšos ar jums.
Vispirms apskatiet ģenerēto webapi dokumentāciju.
1. Nākamajā attēlā parādīta ģenerēšanas palīdzības dokumenta augšējā lapa, kur Vērtības ir kontrolieris, un saraksts zem API parāda http metodi (Get, POST utt.), pieprasījuma darbību un metodes aprakstu.
2. Noklikšķiniet uz saites sarkanajā lodziņā, lai atvērtu API metodes detalizētas informācijas lapu, kā parādīts zemāk redzamajā attēlā.
3. Noklikšķiniet uz Test API, lai atvērtu šo lapu

4. Ievadiet parametrus, noklikšķiniet uz sūtīt pogu, atveriet šo lapu, un jūs varat redzēt atgriezto vērtību.

Iestatīšanas darbības ir šādas:
Izstrādes vide VS2012 + MVC4 + WEB API
1. Atsauce uz tīmekļa API testa klientu, izmantojot NuGet

Atsaucoties uz DLL, tiks izveidots šāds fails:
Šis ir mūsu palīdzības dokumentācijas interfeiss


2. Veiciet šādus iestatījumus projekta rekvizītos, pārbaudiet XMl dokumenta failu un iestatiet ceļu
3. Izveidojiet XmlDocument.xml projekta mapē App_Data
4. Atveriet AreasHelpPageApp_StartHelpPageConfig.cs failu un atceliet šādus koda komentārus

Palaidiet projektu, atveriet http://localhost:3619/Help, un jūs varat redzēt automātiski ģenerēto API dokumentu, kas ir raksta attēls

Projekta lejupielāde:

WebAPIHelper.part2.rar (893.15 KB, Lejupielādes skaits: 1) WebAPIHelper.part1.rar (1.5 MB, Lejupielādes skaits: 0)




Iepriekšējo:SS panelis v3 darbojas Python servers.py kļūda
Nākamo:Bloķējiet peles labo pogu F12 un izvairieties no avota koda skatīšanas
Atruna:
Visa programmatūra, programmēšanas materiāli vai raksti, ko publicē Code Farmer Network, ir paredzēti tikai mācību un pētniecības mērķiem; Iepriekš minēto saturu nedrīkst izmantot komerciāliem vai nelikumīgiem mērķiem, pretējā gadījumā lietotājiem ir jāuzņemas visas sekas. Informācija šajā vietnē nāk no interneta, un autortiesību strīdiem nav nekāda sakara ar šo vietni. Iepriekš minētais saturs ir pilnībā jāizdzēš no datora 24 stundu laikā pēc lejupielādes. Ja jums patīk programma, lūdzu, atbalstiet oriģinālu programmatūru, iegādājieties reģistrāciju un iegūstiet labākus oriģinālus pakalpojumus. Ja ir kādi pārkāpumi, lūdzu, sazinieties ar mums pa e-pastu.

Mail To:help@itsvse.com