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: