Tento článek je zrcadlovým článkem o strojovém překladu, klikněte zde pro přechod na původní článek.

Pohled: 20232|Odpověď: 0

[WebAPI] webAPI automaticky generuje nápovědní dokumentaci

[Kopírovat odkaz]
Zveřejněno 06.10.2016 15:08:16 | | | |
Dříve jsem používal webapi k poskytování rozhraní v projektu a zjistil jsem, že v projektu je automatická generace podpůrných dokumentů podle webapi metod a komentářů, a také můžete testovat webapi metody, které jsou velmi výkonné, a nyní je s vámi sdílím.
Nejprve se podívejte na vygenerovanou dokumentaci webAPI.
1. Následující obrázek ukazuje horní stránku dokumentu s pomocí generace, kde Values je řadič, a seznam pod API ukazuje http metodu (Get, POST atd.), akci požadavku a popis metody.
2. Klikněte na odkaz v červeném poli pro otevření stránky s detaily metody API, jak je znázorněno na obrázku níže.
3. Klikněte na Test API pro otevření následující stránky

4. Zadejte parametry, klikněte na tlačítko Odeslat, otevřete následující stránku a uvidíte vrácenou hodnotu.

Kroky k jeho nastavení jsou následující:
Vývojové prostředí VS2012 + MVC4 + WEB API
1. Odkazujte na testovacího klienta Web API přes NuGet

Odkazování na DLL vygeneruje soubor takto:
Toto je naše rozhraní pro dokumentaci nápovědy


2. Nastavte následující nastavení ve vlastnostech projektu, zkontrolujte soubor dokumentu XMl a nastavte cestu
3. Vytvořte XmlDocument.xml ve složce App_Data projektu
4. Otevřete soubor AreasHelpPageApp_StartHelpPageConfig.cs a zrušte následující komentáře ke kódu

Spusť projekt, otevři http://localhost:3619/Help a uvidíš automaticky generovaný API dokument, což je obrázek článku

Stažení projektu:

WebAPIHelper.part2.rar (893.15 KB, Počet stažení: 1) WebAPIHelper.part1.rar (1.5 MB, Počet stažení: 0)




Předchozí:SS-panel v3 běžící python servers.py chyba
Další:Blokujte pravé tlačítko myši, F12, a vyhněte se prohlížení zdrojového kódu
Zřeknutí se:
Veškerý software, programovací materiály nebo články publikované organizací Code Farmer Network slouží pouze k učení a výzkumu; Výše uvedený obsah nesmí být používán pro komerční ani nelegální účely, jinak nesou všechny důsledky uživatelé. Informace na tomto webu pocházejí z internetu a spory o autorská práva s tímto webem nesouvisí. Musíte výše uvedený obsah ze svého počítače zcela smazat do 24 hodin od stažení. Pokud se vám program líbí, podporujte prosím originální software, kupte si registraci a získejte lepší skutečné služby. Pokud dojde k jakémukoli porušení, kontaktujte nás prosím e-mailem.

Mail To:help@itsvse.com