Tidligere brugte jeg webapi til at levere grænseflader i projektet, og fandt ud af, at der i projektet automatisk genereres hjælpedokumenter i henhold til webapi-metoder og kommentarer, og man kan også teste webapi-metoder, som er meget kraftfulde, og nu vil jeg dele dem med jer.
Tag et kig på den genererede webapi-dokumentation først.
1. Følgende figur viser øverste side i genereringshjælpedokumentet, hvor Values er controlleren, og listen under API'et viser http-metoden (Get, POST osv.), handlingen af anmodningen og beskrivelsen af metoden.
2. Klik på linket i den røde boks for at åbne detailsiden for API-metoden, som vist i figuren nedenfor.
3. Klik på Test API for at åbne følgende side
4. Indtast parametrene, klik på Send-knappen, åbn følgende side, og du kan se returværdien.
Trinene til at sætte det op er som følger:
Udviklingsmiljø VS2012 + MVC4 + WEB API
1. Henvis til Web API-testklienten gennem NuGet
Ved at referere til DLL'en genereres en fil som denne:
Dette er vores hjælpedokumentationsgrænseflade
2. Foretag følgende indstillinger i projektegenskaberne, tjek XMl-dokumentfilen, og sæt stien
3. Opret en XmlDocument.xml under projektets App_Data-mappe
4. Åbn AreasHelpPageApp_StartHelpPageConfig.cs-filen og annuller følgende kodekommentarer
Kør projektet, åbn http://localhost:3619/Help, og du kan se det automatisk genererede API-dokument, som er et billede af artiklen
Projektdownload:
Opslået på 06/10/2016 15.08.16
|
|
|
|
