Prej sem uporabljal webapi za zagotavljanje vmesnikov v projektu in ugotovil, da je v projektu samodejno generiranje podpornih dokumentov glede na webapi metode in komentarje, prav tako pa lahko testirate webapi metode, ki so zelo zmogljive, zdaj pa jih bom delil z vami.
Najprej si oglejte generirano webapi dokumentacijo.
1. Naslednja slika prikazuje zgornjo stran dokumenta za pomoč pri generiranju, kjer je Values krmilnik, seznam pod API-jem pa prikazuje http metodo (Get, POST itd.), dejanje zahteve in opis metode.
2. Kliknite povezavo v rdečem okvirju, da odprete stran s podrobnostmi API metode, kot je prikazano na spodnji sliki.
3. Kliknite Test API, da odprete naslednjo stran
4. Vnesite parametre, kliknite gumb Pošlji, odprite naslednjo stran in lahko vidite povratno vrednost.
Koraki za vzpostavitev so naslednji:
Razvojno okolje VS2012 + MVC4 + WEB API
1. Preverite testni odjemalec spletnega API-ja preko NuGeta
Referenca na DLL bo ustvarila datoteko, kot je ta:
To je naš vmesnik za dokumentacijo pomoči
2. Nastavite naslednje nastavitve v lastnostih projekta, preverite datoteko XMl in nastavite pot
3. Ustvarite XmlDocument.xml pod mapo App_Data projekta
4. Odprite AreasHelpPageApp_StartHelpPageConfig.cs datoteko in prekličite naslednje komentarje kode
Zaženi projekt, odpri http://localhost:3619/Help in vidiš samodejno generiran API dokument, ki je slika članka
Prenos projekta: