Tidigare använde jag webapi för att tillhandahålla gränssnitt i projektet, och upptäckte att det i projektet automatiskt genereras hjälpdokument enligt webapi-metoder och kommentarer, och du kan också testa webapi-metoder, som är mycket kraftfulla, och nu kommer jag att dela dem med dig.
Titta först på den genererade webapi-dokumentationen.
1. Följande figur visar översta sidan i genereringsdokumentet, där Values är kontrollern, och listan nedanför API:et visar http-metoden (Get, POST, etc.), handlingen i förfrågan och beskrivningen av metoden.
2. Klicka på länken i den röda rutan för att öppna detaljsidan för API-metoden, som visas i figuren nedan.
3. Klicka på Test API för att öppna följande sida
4. Ange parametrarna, klicka på Skicka-knappen, öppna nästa sida och du kan se returvärdet.
Stegen för att sätta upp den är följande:
Utvecklingsmiljö VS2012 + MVC4 + WEB API
1. Referera till Web API Testklienten via NuGet
Att referera till DLL genererar en fil som denna:
Detta är vårt gränssnitt för dokumentation av hjälp
2. Gör följande inställningar i projektegenskaperna, kontrollera XMl-dokumentfilen och ställ in sökvägen
3. Skapa en XmlDocument.xml under projektets App_Data-mapp
4. Öppna AreasHelpPageApp_StartHelpPageConfig.cs-filen och avbryt följande kodkommentarer
Kör projektet, öppna http://localhost:3619/Help, och du kan se det automatiskt genererade API-dokumentet, som är en bild av artikeln
Projektnedladdning: