Ten artykuł jest lustrzanym artykułem tłumaczenia maszynowego, kliknij tutaj, aby przejść do oryginalnego artykułu.

Widok: 20232|Odpowiedź: 0

[WebAPI] webAPI automatycznie generuje dokumentację pomocy

[Skopiuj link]
Opublikowano 06.10.2016 15:08:16 | | | |
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:

WebAPIHelper.part2.rar (893.15 KB, Liczba pobranych plików: 1) WebAPIHelper.part1.rar (1.5 MB, Liczba pobranych plików: 0)




Poprzedni:SS-panel v3 uruchamiający Python servers.py błąd
Następny:Zablokuj kliknięcie prawym przyciskiem myszy, F12, i unikaj przeglądania kodu źródłowego
Zrzeczenie się:
Całe oprogramowanie, materiały programistyczne lub artykuły publikowane przez Code Farmer Network służą wyłącznie celom edukacyjnym i badawczym; Powyższe treści nie mogą być wykorzystywane do celów komercyjnych ani nielegalnych, w przeciwnym razie użytkownicy ponoszą wszelkie konsekwencje. Informacje na tej stronie pochodzą z Internetu, a spory dotyczące praw autorskich nie mają z nią nic wspólnego. Musisz całkowicie usunąć powyższą zawartość z komputera w ciągu 24 godzin od pobrania. Jeśli spodoba Ci się program, wspieraj oryginalne oprogramowanie, kup rejestrację i korzystaj z lepszych, autentycznych usług. W przypadku naruszenia praw prosimy o kontakt mailowy.

Mail To:help@itsvse.com