Tidligere brukte jeg webapi til å tilby grensesnitt i prosjektet, og fant ut at det i prosjektet automatisk genereres hjelpedokumenter i henhold til webapi-metoder og kommentarer, og du kan også teste webapi-metoder, som er veldig kraftige, og nå vil jeg dele dem med deg.
Ta en titt på den genererte webapi-dokumentasjonen først.
1. Følgende figur viser øverste side i genereringshjelpedokumentet, hvor Values er kontrolleren, og listen under API-et viser http-metoden (Get, POST, osv.), handlingen i forespørselen og beskrivelsen av metoden.
2. Klikk på lenken i den røde boksen for å åpne detaljsiden til API-metoden, som vist i figuren under.
3. Klikk på Test API for å åpne neste side
4. Skriv inn parameterne, klikk på Send-knappen, åpne neste side, og du kan se returverdien.
Stegene for å sette det opp er som følger:
Utviklingsmiljø VS2012 + MVC4 + WEB API
1. Referer til Web API-testklienten via NuGet
Å referere til DLL-en vil generere en fil som denne:
Dette er vårt hjelpedokumentasjonsgrensesnitt
2. Gjør følgende innstillinger i prosjektegenskapene, sjekk XMl-dokumentfilen, og sett stien
3. Opprett en XmlDocument.xml under App_Data-mappen i prosjektet
4. Åpne AreasHelpPageApp_StartHelpPageConfig.cs-filen og avbryt følgende kodekommentarer
Kjør prosjektet, åpne http://localhost:3619/Help, og du kan se det automatisk genererte API-dokumentet, som er et bilde av artikkelen
Prosjektnedlasting:
Publisert på 06.10.2016 15:08:16
|
|
|
|
