Predtým som používal webapi na poskytovanie rozhraní v projekte a zistil som, že v projekte sa automaticky generujú dokumenty pomoci podľa webapi metód a komentárov, a môžete tiež testovať webapi metódy, ktoré sú veľmi výkonné, a teraz ich s vami zdieľam.
Najskôr si pozrite vygenerovanú webapi dokumentáciu.
1. Nasledujúci obrázok ukazuje vrchnú stránku dokumentu s pomocou generovania, kde Values je kontrolér a zoznam pod API zobrazuje http metódu (Get, POST a pod.), akciu požiadavky a popis metódy.
2. Kliknite na odkaz v červenom poli a otvorte stránku s detailmi metódy API, ako je znázornené na obrázku nižšie.
3. Kliknite na Test API pre otvorenie nasledujúcej stránky
4. Zadajte parametre, kliknite na tlačidlo Odoslať, otvorte nasledujúcu stránku a uvidíte vrátenú hodnotu.
Kroky na jeho nastavenie sú nasledovné:
Vývojové prostredie VS2012 + MVC4 + WEB API
1. Odkazujte na testovacieho klienta webového API cez NuGet
Odkazovanie na DLL vygeneruje súbor ako tento:
Toto je naše rozhranie na dokumentáciu pomoci
2. Nastavte nasledujúce vlastnosti projektu, skontrolujte súbor dokumentu XMl a nastavte cestu
3. Vytvorte XmlDocument.xml v App_Data priečinku projektu
4. Otvorte AreasHelpPageApp_StartHelpPageConfig.cs súbor a zrušte nasledujúce kódové komentáre
Spustíte projekt, otvoríte http://localhost:3619/Help a uvidíte automaticky generovaný API dokument, ktorý je obrázkom článku
Stiahnutie projektu:
Zverejnené 6. 10. 2016 15:08:16
|
|
|
|
