Wcześniej używałem webapi do udostępniania interfejsów w projekcie i zauważyłem, że w projekcie istnieje automatyczne generowanie dokumentów pomocy według metod i komentarzy webapi, a także można testować metody webapi, które są bardzo skuteczne, i teraz się nimi z Wami podzielę.
Najpierw zerknij na wygenerowaną dokumentację WebAPI.
1. Poniższy rysunek pokazuje główną stronę dokumentu pomocy generowania, gdzie Values jest kontrolerem, a lista poniżej API pokazuje metodę http (Get, POST itd.), akcję żądania oraz opis metody.
2. Kliknij link w czerwonym polu, aby otworzyć stronę szczegółów metody API, jak pokazano na poniższym rysunku.
3. Kliknij Test API, aby otworzyć następną stronę
4. Wprowadź parametry, kliknij przycisk Wyślij, otwórz następną stronę i zobaczysz wartość zwrotną.
Kroki do jego konfiguracji są następujące:
Środowisko deweloperskie VS2012 + MVC4 + WEB API
1. Odwołanie się do klienta testowego Web API za pomocą NuGet
Odniesienie do DLL generuje plik w ten sposób:
To jest nasz interfejs dokumentacji pomocy
2. Ustaw następujące ustawienia w właściwościach projektu, sprawdź plik dokumentu XMl i ustaw ścieżkę
3. Stwórz XmlDocument.xml w folderze App_Data projektu
4. Otwórz plik AreasHelpPageApp_StartHelpPageConfig.cs i anuluj następujące komentarze kodowe
Uruchom projekt, otwórz http://localhost:3619/Help i zobaczysz automatycznie wygenerowany dokument API, który jest obrazem artykułu
Pobierz projekt: