Praktické cvičení: jeden ASP.NET: Integrace webových formulářů ASP.NET, MVC a webového rozhraní API

Článek
2023-07-13

ASP.NET je architektura pro vytváření webů, aplikací a služeb pomocí specializovaných technologií, jako jsou MVC, webové rozhraní API a další. S rozmachem ASP.NET, ke kterým došlo od svého vzniku, a s vyjádřenou potřebou integrovat tyto technologie, došlo v nedávné době k úsilí o vytvoření jedné ASP.NET.

Visual Studio 2013 zavádí nový jednotný projektový systém, který umožňuje sestavit aplikaci a používat všechny ASP.NET technologie v jednom projektu. Tato funkce eliminuje potřebu vybrat jednu technologii na začátku projektu a držet se jí, a místo toho podporuje použití více ASP.NET architektur v rámci jednoho projektu.

Všechny ukázkové kódy a fragmenty kódu jsou součástí sady Web Camps Training Kit, která je k dispozici na adrese https://aka.ms/webcamps-training-kit.

Přehled

Cíle

V tomto praktickém cvičení se naučíte:

Vytvoření webu založeného na typu projektu One ASP.NET
Použití různých rozhraní ASP.NET , jako je MVC a webové rozhraní API , ve stejném projektu
Identifikace hlavních komponent aplikace ASP.NET
Využijte rozhraní ASP.NET scaffolding k automatickému vytváření kontrolorů a zobrazení pro provádění operací CRUD na základě tříd modelu.
Zveřejnění stejné sady informací ve strojově a člověkem čitelných formátech pomocí správného nástroje pro každou úlohu

Požadavky

K dokončení tohoto praktického cvičení se vyžaduje následující:

Visual Studio Express 2013 pro web nebo novější
Visual Studio 2013 Update 1

Nastavení

Abyste mohli spustit cvičení v tomto praktickém cvičení, musíte nejprve nastavit prostředí.

Otevřete Průzkumníka Windows a přejděte do složky Zdroj v testovacím prostředí.
Klikněte pravým tlačítkem na Setup.cmd a vyberte Spustit jako správce a spusťte proces instalace, který nakonfiguruje vaše prostředí a nainstaluje fragmenty kódu sady Visual Studio pro toto cvičení.
Pokud se zobrazí dialogové okno Řízení uživatelských účtů, potvrďte akci, která má pokračovat.

Poznámka

Před spuštěním instalace se ujistěte, že jste zkontrolovali všechny závislosti pro toto testovací prostředí.

Použití fragmentů kódu

V celém dokumentu testovacího prostředí budete vyzváni k vložení bloků kódu. Pro usnadnění přístupu je většina tohoto kódu k dispozici jako fragmenty kódu sady Visual Studio Code, ke kterým můžete přistupovat z Visual Studio 2013, abyste ho nemuseli přidávat ručně.

Poznámka

Každé cvičení je doprovázeno počátečním řešením umístěným ve složce Begin daného cvičení, které vám umožní sledovat každé cvičení nezávisle na ostatních cvičeních. Mějte na paměti, že fragmenty kódu přidané během cvičení v těchto počátečních řešeních chybí a nemusí fungovat, dokud cvičení nedokončíte. Ve zdrojovém kódu cvičení najdete také složku End obsahující řešení sady Visual Studio s kódem, který je výsledkem dokončení kroků v příslušném cvičení. Tato řešení můžete použít jako vodítko, pokud potřebujete další pomoc při práci v tomto praktickém cvičení.

Cvičení

Toto praktické cvičení zahrnuje následující cvičení:

Vytvoření nového projektu Web Forms
Vytvoření kontroleru MVC pomocí generování uživatelského rozhraní
Vytvoření kontroleru webového rozhraní API pomocí generování uživatelského rozhraní

Odhadovaná doba dokončení tohoto cvičení: 60 minut

Poznámka

Při prvním spuštění sady Visual Studio musíte vybrat jednu z předdefinovaných kolekcí nastavení. Každá předdefinovaná kolekce je navržená tak, aby odpovídala konkrétnímu stylu vývoje a určuje rozložení oken, chování editoru, fragmenty kódu IntelliSense a možnosti dialogového okna. Postupy v tomto cvičení popisují akce potřebné k provedení daného úkolu v sadě Visual Studio při použití kolekce Obecné nastavení vývoje . Pokud pro vývojové prostředí zvolíte jinou kolekci nastavení, můžou existovat rozdíly v krocích, které byste měli vzít v úvahu.

Cvičení 1: Vytvoření nového projektu Web Forms

V tomto cvičení vytvoříte nový web Web Forms v Visual Studio 2013 pomocí jednotného prostředí projektu One ASP.NET, které vám umožní snadno integrovat komponenty Web Forms, MVC a webového rozhraní API do stejné aplikace. Pak prozkoumáte vygenerované řešení a identifikujete jeho části a nakonec uvidíte web v akci.

Úkol 1 – vytvoření nového webu pomocí prostředí One ASP.NET

V tomto úkolu začnete vytvářet nový web v sadě Visual Studio na základě typu projektu One ASP.NET . Jeden ASP.NET sjednocuje všechny ASP.NET technologie a umožňuje je podle potřeby kombinovat a spárovat. Pak rozpoznáte různé komponenty Web Forms, MVC a webového rozhraní API, které jsou ve vaší aplikaci vedle sebe.

Otevřete Visual Studio Express 2013 pro web a vyberte Soubor | Nový projekt... a zahajte nové řešení.

Vytvoření nového projektu
V dialogovém okně Nový projekt vyberte ASP.NET Webová aplikace v části Visual C# | Webová karta a ujistěte se, že je vybraná možnost rozhraní .NET Framework 4.5 . Pojmenujte projekt MyHybridSite, zvolte Umístění a klikněte na OK.

Vytvoření nového projektu webové aplikace ASP.NET
V dialogovém okně Nový projekt ASP.NET vyberte šablonu Web Forms a vyberte možnosti MVC a Webové rozhraní API. Ujistěte se také, že je možnost Ověřování nastavená na Individuální uživatelské účty. Pokračujte kliknutím na tlačítko OK.

Vytvoření nového projektu pomocí šablony Web Forms, včetně webových rozhraní API a komponent MVC
Teď můžete prozkoumat strukturu vygenerovaného řešení.

Prozkoumání vygenerovaného řešení
1. Účet: Tato složka obsahuje stránky webového formuláře pro registraci, přihlášení a správu uživatelských účtů aplikace. Tato složka se přidá, když je během konfigurace šablony projektu Web Forms vybrána možnost ověřování individuálních uživatelských účtů.
2. Modely: Tato složka bude obsahovat třídy, které představují data vaší aplikace.
3. Kontrolery a zobrazení: Tyto složky jsou vyžadovány pro komponenty webového rozhraní API ASP.NET MVC a ASP.NET . Technologie MVC a webového rozhraní API prozkoumáte v dalších cvičeních.
4. Soubory Default.aspx, Contact.aspx a About.aspx jsou předdefinované stránky webových formulářů, které můžete použít jako výchozí body k vytvoření stránek specifických pro vaši aplikaci. Programovací logika těchto souborů se nachází v samostatném souboru označovaného jako soubor "code-behind", který má příponu ".aspx.vb" nebo ".aspx.cs" (v závislosti na použitém jazyce). Logika kódu na pozadí běží na serveru a dynamicky vytváří výstup HTML pro vaši stránku.
5. Stránky Site.Master a Site.Mobile.Master definují vzhled a chování a standardní chování všech stránek v aplikaci.
Poklikáním na soubor Default.aspx prozkoumejte obsah stránky.

Prozkoumání stránky Default.aspx

Poznámka

Direktiva Page v horní části souboru definuje atributy stránky Web Forms. Například MasterPageFile atribut určuje cestu ke stránce předlohy - v tomto případě Site.Master stránka - a Inherits atribut definuje kód na pozadí třídy stránky, která se má dědit. Tato třída se nachází v souboru určeném atributem CodeBehind .

Ovládací prvek asp:Content obsahuje skutečný obsah stránky (text, značky a ovládací prvky) a je mapován na ovládací prvek asp:ContentPlaceHolder na stránce předlohy. V tomto případě se obsah stránky vykreslí uvnitř ovládacího prvku MainContent definovaného na stránce Site.Master .
Rozbalte složku App_Start a všimněte si souboru WebApiConfig.cs . Visual Studio tento soubor zahrnula do vygenerovaného řešení, protože jste zahrnuli webové rozhraní API při konfiguraci projektu pomocí šablony One ASP.NET.

Otevřete soubor WebApiConfig.cs . Ve třídě WebApiConfig najdete konfiguraci přidruženou k webovému rozhraní API, které mapuje trasy HTTP na kontrolery webového rozhraní API.

public static void Register(HttpConfiguration config)
{
    // Web API configuration and services

    // Web API routes
    config.MapHttpAttributeRoutes();

    config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );
}

Otevřete soubor RouteConfig.cs . V metodě RegisterRoutes najdete konfiguraci přidruženou k MVC, která mapuje trasy HTTP na kontrolery MVC.

public static void RegisterRoutes(RouteCollection routes)
{
    var settings = new FriendlyUrlSettings();
    settings.AutoRedirectMode = RedirectMode.Permanent;
    routes.EnableFriendlyUrls(settings);

    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapRoute(
            name: "Default",
            url: "{controller}/{action}/{id}",
            defaults: new { action = "Index", id = UrlParameter.Optional }
        );
}

Úloha 2 – spuštění řešení

V této úloze spustíte vygenerované řešení, prozkoumáte aplikaci a některé její funkce, jako je přepsání adresy URL a integrované ověřování.

Pokud chcete řešení spustit, stiskněte klávesu F5 nebo klikněte na tlačítko Start umístěné na panelu nástrojů. Domovská stránka aplikace by se měla otevřít v prohlížeči.
Ověřte, že jsou vyvolány stránky Web Forms. Uděláte to tak, že k adrese URL na panelu Adresa připojíte adresu /contact.aspx a stisknete Enter.

Popisné adresy URL

Poznámka

Jak vidíte, adresa URL se změní na /contact. Od ASP.NET 4 byly do Web Forms přidány možnosti směrování adres URL, takže můžete místo napsat adresy URL jako http://www.mysite.com/products/softwarehttp://www.mysite.com/products.aspx?category=software. Další informace najdete v tématu Směrování adres URL.
Teď prozkoumáte tok ověřování integrovaný do aplikace. Uděláte to tak, že v pravém horním rohu stránky kliknete na Zaregistrovat .

Registrace nového uživatele
Na stránce Register (Zaregistrovat) zadejte Uživatelské jméno a Heslo a klikněte na Register (Zaregistrovat).

Stránka Registrace
Aplikace zaregistruje nový účet a uživatel se ověří.

Ověřeno uživatelem
Zpět do sady Visual Studio a stisknutím shift + F5 zastavíte ladění.

Cvičení 2: Vytvoření kontroleru MVC pomocí generování uživatelského rozhraní

V tomto cvičení využijete rozhraní ASP.NET scaffolding poskytované sadou Visual Studio k vytvoření kontroleru ASP.NET MVC 5 s akcemi a zobrazeními Razor k provádění operací CRUD bez zápisu jediného řádku kódu. Proces generování uživatelského rozhraní použije Entity Framework Code First k vygenerování kontextu dat a schématu databáze v databázi SQL.

Informace o Entity Framework Code First

Entity Framework (EF) je objektově relační mapovač (ORM), který umožňuje vytvářet aplikace pro přístup k datům programováním s koncepčním aplikačním modelem místo programování přímo pomocí schématu relačního úložiště.

Pracovní postup modelování Entity Framework Code First umožňuje použít vlastní třídy domény k reprezentaci modelu, na který EF spoléhá při dotazování, sledování změn a aktualizaci funkcí. Při použití vývojového pracovního postupu Code First nemusíte aplikaci zahajovat vytvořením databáze nebo zadáním schématu. Místo toho můžete psát standardní třídy .NET, které definují nejvhodnější objekty doménového modelu pro vaši aplikaci, a Entity Framework vytvoří databázi za vás.

Poznámka

Další informace o službě Entity Framework najdete tady.

Úkol 1 – vytvoření nového modelu

Teď definujete třídu Person , která bude modelem používaným procesem generování uživatelského rozhraní k vytvoření kontroleru MVC a zobrazení. Začnete vytvořením třídy modelu Person a operace CRUD v kontroleru se automaticky vytvoří pomocí funkcí generování uživatelského rozhraní.

Otevřete Visual Studio Express 2013 for Web a řešení MyHybridSite.sln umístěné ve složce Source/Ex2-MvcScaffolding/Begin. Případně můžete pokračovat s řešením, které jste získali v předchozím cvičení.
V Průzkumník řešení klikněte pravým tlačítkem myši na složku Models projektu MyHybridSite a vyberte Přidat | třída....

Přidání třídy modelu Person
V dialogovém okně Přidat novou položku pojmenujte soubor Person.cs a klikněte na Přidat.

Vytvoření třídy modelu Person

Obsah souboru Person.cs nahraďte následujícím kódem. Stisknutím kombinace kláves CTRL + S uložte změny.

(Fragment kódu – BringingTogetherOneAspNet – Ex2 – PersonClass)

namespace MyHybridSite.Models
{
    public class Person
    {
        public int Id { get; set; }

        public string Name { get; set; }

        public int Age { get; set; }
    }
}

V Průzkumník řešení klikněte pravým tlačítkem na projekt MyHybridSite a vyberte Sestavit nebo stisknutím kombinace kláves CTRL + SHIFT + B vytvořte projekt.

Úkol 2 – vytvoření kontroleru MVC

Teď, když je vytvořený model Person , použijete ASP.NET generování uživatelského rozhraní MVC s Entity Frameworkem k vytvoření akcí a zobrazení kontroleru CRUD pro person.

V Průzkumník řešení klikněte pravým tlačítkem na složku Controllers projektu MyHybridSite a vyberte Přidat | Nová vygenerovaná položka....

Vytvoření nového vygenerovaného kontroleru
V dialogovém okně Přidat generování uživatelského rozhraní vyberte Kontroler MVC 5 se zobrazeními pomocí Entity Frameworku a pak klikněte na Přidat.

Výběr kontroleru MVC 5 se zobrazeními a Entity Frameworku
Jako název kontroleru nastavte MvcPersonController, vyberte možnost Použít akce asynchronního kontroleru a jako třídu Model vyberte Person (MyHybridSite.Models).

Přidání kontroleru MVC s využitím generování uživatelského rozhraní
V části Třída kontextu dat klikněte na Nový kontext dat....

Vytvoření nového kontextu dat
V dialogovém okně Nový kontext dat pojmenujte nový kontext dat PersonContext a klikněte na Přidat.

Vytvoření nového typu PersonContext
Kliknutím na Přidat vytvořte nový kontroler pro uživatele s generováním uživatelského rozhraní. Visual Studio pak vygeneruje akce kontroleru, kontext osobních dat a zobrazení Razor.

Po vytvoření kontroleru MVC s využitím generování uživatelského rozhraní

Otevřete soubor MvcPersonController.cs ve složce Controllers . Všimněte si, že se automaticky vygenerovaly metody akce CRUD.

...

// POST: /MvcPerson/Create
// To protect from overposting attacks, please enable the specific properties you want to bind to, for 
// more details see https://go.microsoft.com/fwlink/?LinkId=317598.
[HttpPost]
[ValidateAntiForgeryToken]
public async Task<ActionResult> Create([Bind(Include="Id,Name,Age")] Person person)
{
     if (ModelState.IsValid)
     {
          db.People.Add(person);
          await db.SaveChangesAsync();
          return RedirectToAction("Index");
     }

     return View(person);
}

// GET: /MvcPerson/Edit/5
public async Task<ActionResult> Edit(int? id)
{
     if (id == null)
     {
          return new HttpStatusCodeResult(HttpStatusCode.BadRequest);
     }
     Person person = await db.People.FindAsync(id);
     if (person == null)
     {
          return HttpNotFound();
     }
     return View(person);
}

...

Poznámka

Zaškrtnutím políčka Použít akce asynchronního kontroleru v možnostech generování uživatelského rozhraní v předchozích krocích vygeneruje Visual Studio asynchronní metody akcí pro všechny akce, které zahrnují přístup k kontextu osobních dat. Doporučuje se používat asynchronní metody akcí pro dlouhotrvající požadavky vázané na procesor, aby se zabránilo blokování webového serveru v provádění práce během zpracování požadavku.

Úloha 3 – spuštění řešení

V této úloze znovu spustíte řešení, abyste ověřili, že zobrazení pro osobu fungují podle očekávání. Přidáte novou osobu, abyste ověřili, že se úspěšně uložila do databáze.

Stisknutím klávesy F5 spusťte řešení.
Přejděte na /MvcPerson. Mělo by se zobrazit vygenerované zobrazení se seznamem lidí.
Kliknutím na Vytvořit novou přidáte novou osobu.

Přechod k vygenerovaným zobrazením MVC
V zobrazení Vytvořit zadejte jméno a věk osoby a klikněte na Vytvořit.

Přidání nové osoby
Nová osoba se přidá do seznamu. V seznamu prvků klikněte na Podrobnosti , aby se zobrazilo zobrazení podrobností osoby. Potom v zobrazení Podrobností klikněte na Zpět do seznamu a vraťte se do zobrazení seznamu.

Zobrazení podrobností o osobě
Kliknutím na odkaz Odstranit osobu odstraňte. V zobrazení Odstranit operaci potvrďte kliknutím na Odstranit .

Odstranění osoby
Zpět do sady Visual Studio a stisknutím shift + F5 zastavíte ladění.

Cvičení 3: Vytvoření kontroleru webového rozhraní API pomocí generování uživatelského rozhraní

Architektura webového rozhraní API je součástí zásobníku ASP.NET a je navržená tak, aby usnadnila implementaci služeb HTTP a obecně prostřednictvím rozhraní RESTful API odesílala a přijímala data ve formátu JSON nebo XML.

V tomto cvičení znovu použijete ASP.NET generování uživatelského rozhraní k vygenerování kontroleru webového rozhraní API. K poskytnutí stejných osobních dat ve formátu JSON použijete stejné třídy Person a PersonContext z předchozího cvičení. Uvidíte, jak můžete zveřejnit stejné prostředky různými způsoby v rámci stejné ASP.NET aplikace.

Úloha 1 – vytvoření kontroleru webového rozhraní API

V této úloze vytvoříte nový kontroler webového rozhraní API , který zveřejní data osob ve strojově využitelném formátu, jako je JSON.

Pokud ještě není otevřen, otevřete Visual Studio Express 2013 for Web a otevřete řešení MyHybridSite.sln umístěné ve složce Source/Ex3-WebAPI/Begin. Případně můžete pokračovat s řešením, které jste získali v předchozím cvičení.

Poznámka

Pokud začnete řešením Začít ve cvičení 3, vytvořte řešení stisknutím kombinace kláves CTRL + SHIFT + B .
V Průzkumník řešení klikněte pravým tlačítkem na složku Controllers projektu MyHybridSite a vyberte Přidat | Nová vygenerovaná položka....

Vytvoření nového vygenerovaného kontroleru
V dialogovém okně Přidat scaffold vyberte v levém podokně webové rozhraní API , pak Kontroler webového rozhraní API 2 s akcemi pomocí Entity Framework v prostředním podokně a potom klikněte na Přidat.

Výběr kontroleru webového rozhraní API 2 s akcemi a Entity Frameworku
Jako název kontroleru nastavte ApiPersonController, vyberte možnost Použít akce asynchronního kontroleru a jako třídy kontextu Model a Data vyberte Person (MyHybridSite.Models) a PersonContext (MyHybridSite.Models). Pak klikněte na Přidat.

Přidání kontroleru webového rozhraní API s využitím generování uživatelského rozhraní
Visual Studio pak vygeneruje třídu ApiPersonController se čtyřmi akcemi CRUD pro práci s vašimi daty.

Po vytvoření kontroleru webového rozhraní API s využitím generování uživatelského rozhraní
Otevřete soubor ApiPersonController.cs a zkontrolujte metodu akce GetPeople . Tato metoda se dotazuje na pole db typu PersonContext , aby bylo možné získat data o lidech.
```
// GET api/ApiPerson
public IQueryable<Person> GetPeople()
{
    return db.People;
}
```
Teď si všimněte komentáře nad definicí metody. Poskytuje identifikátor URI, který zpřístupňuje tuto akci, kterou použijete v další úloze.
```
// GET api/ApiPerson
public IQueryable<Person> GetPeople()
{
    return db.People;
}
```
Poznámka

Ve výchozím nastavení je webové rozhraní API nakonfigurované tak, aby zachytávejte dotazy na cestu /api , aby nedocházelo ke kolizím s řadiči MVC. Pokud potřebujete toto nastavení změnit, projděte si téma Směrování ve webovém rozhraní API ASP.NET.

Úloha 2 – spuštění řešení

V této úloze použijete vývojářské nástroje Internet Exploreru F12 ke kontroleru webového rozhraní API. Uvidíte, jak můžete zachytit síťový provoz, abyste získali lepší přehled o datech aplikací.

Poznámka

Ujistěte se, že je na tlačítku Start na panelu nástrojů sady Visual Studio vybraný Internet Explorer.

Možnost Internet Exploreru

Vývojářské nástroje F12 mají širokou škálu funkcí, které nejsou popsané v tomto praktickém cvičení. Pokud se o tom chcete dozvědět víc, přečtěte si téma Použití vývojářských nástrojů F12.

Stisknutím klávesy F5 spusťte řešení.

Poznámka

Aby bylo možné tuto úlohu správně sledovat, musí mít vaše aplikace data. Pokud je vaše databáze prázdná, můžete se vrátit k úloze 3 ve cvičení 2 a postupovat podle pokynů k vytvoření nové osoby pomocí zobrazení MVC.
V prohlížeči stisknutím klávesy F12 otevřete panel Vývojářské nástroje . Stiskněte klávesu CTRL + 4 nebo klikněte na ikonu Síť a potom kliknutím na tlačítko se zelenou šipkou začněte zaznamenávat síťový provoz.

Inicializování zachytávání sítě webového rozhraní API
Připojte api/ApiPerson k adrese URL v adresní řádku prohlížeče. Teď zkontrolujete podrobnosti odpovědi z apiPersonControlleru.

Načítání dat osob prostřednictvím webového rozhraní API

Poznámka

Po dokončení stahování se zobrazí výzva k provedení akce se staženým souborem. Nechte dialogové okno otevřené, aby bylo možné watch obsah odpovědi prostřednictvím okna Nástroje pro vývojáře.
Teď zkontrolujete tělo odpovědi. Uděláte to tak, že kliknete na kartu Podrobnosti a potom kliknete na Text odpovědi. Můžete zkontrolovat, že stažená data jsou seznam objektů s vlastnostmi ID, Jméno a Věk , které odpovídají třídě Person .

Zobrazení textu odpovědi webového rozhraní API

Úloha 3 – přidání stránek nápovědy k webovému rozhraní API

Při vytváření webového rozhraní API je užitečné vytvořit stránku nápovědy, aby ostatní vývojáři věděli, jak volat vaše rozhraní API. Stránky dokumentace můžete vytvořit a aktualizovat ručně, ale je lepší je automaticky vygenerovat, abyste nemuseli provádět údržbu. V této úloze použijete balíček NuGet k automatickému vygenerování stránek nápovědy webového rozhraní API pro řešení.

V nabídce Nástroje v sadě Visual Studio vyberte Správce balíčků NuGet a pak klikněte na Konzola Správce balíčků.
V okně konzoly Správce balíčků spusťte následující příkaz:
```
Install-Package Microsoft.AspNet.WebApi.HelpPage
```
Poznámka

Balíček Microsoft.AspNet.WebApi.HelpPage nainstaluje potřebná sestavení a přidá zobrazení MVC pro stránky nápovědy do složky Areas/HelpPage .

Oblast helppage
Ve výchozím nastavení mají stránky nápovědy zástupné řetězce pro dokumentaci. K vytvoření dokumentace můžete použít komentáře k dokumentaci XML. Pokud chcete tuto funkci povolit, otevřete soubor HelpPageConfig.cs umístěný ve složce Areas/HelpPage/App_Start a zrušte komentář na následujícím řádku:
```
config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));
```
V Průzkumník řešení klikněte pravým tlačítkem na projekt MyHybridSite, vyberte Vlastnosti a klikněte na kartu Sestavení.

Karta Sestavení
V části Výstup vyberte Soubor dokumentace XML. Do textového pole zadejte App_Data/XmlDocument.xml.

Oddíl Výstup na kartě Sestavení
Stisknutím klávesy CTRL + S uložte změny.
Otevřete soubor ApiPersonController.cs ze složky Controllers .
Zadejte nový řádek mezi signaturu metody GetPeople a komentářem get api/ApiPerson a zadejte tři lomítka.

Poznámka

Visual Studio automaticky vloží elementy XML, které definují dokumentaci k metodě.

Přidejte souhrnný text a návratovou hodnotu metody GetPeople . Mělo by to vypadat následovně.

// GET api/ApiPerson
/// <summary>
/// Documentation for 'GET' method
/// </summary>
/// <returns>Returns a list of people in the requested format</returns>
public IQueryable<Person> GetPeople()
{
    return db.People;
}

Stisknutím klávesy F5 spusťte řešení.
Pokud chcete přejít na stránku nápovědy, připojte k adrese URL na panelu Adresa adresu /help .

Stránka nápovědy k webovému rozhraní API ASP.NET

Poznámka

Hlavním obsahem stránky je tabulka rozhraní API seskupených podle kontroleru. Položky tabulky se generují dynamicky pomocí rozhraní IApiExplorer . Pokud přidáte nebo aktualizujete kontroler rozhraní API, tabulka se automaticky aktualizuje při příštím sestavení aplikace.

Ve sloupci rozhraní API je uvedena metoda HTTP a relativní identifikátor URI. Sloupec Popis obsahuje informace, které byly extrahovány z dokumentace metody.
Všimněte si, že popis, který jste přidali nad definici metody, se zobrazí ve sloupci popis.

Popis metody rozhraní API
Kliknutím na jednu z metod rozhraní API přejděte na stránku s podrobnějšími informacemi, včetně ukázkových těl odpovědí.

Stránka s podrobnými informacemi

Souhrn

Dokončením tohoto praktického cvičení jste se naučili:

Vytvoření nové webové aplikace pomocí prostředí One ASP.NET v Visual Studio 2013
Integrace několika ASP.NET technologií do jednoho projektu
Generování kontrolérů A zobrazení MVC z tříd modelu pomocí ASP.NET generování uživatelského rozhraní
Generování kontrolerů webového rozhraní API, které používají funkce, jako je asynchronní programování a přístup k datům prostřednictvím Entity Frameworku
Automatické generování stránek nápovědy webového rozhraní API pro kontrolery

Sdílet prostřednictvím

Praktické cvičení: jeden ASP.NET: Integrace webových formulářů ASP.NET, MVC a webového rozhraní API

Přehled

Cíle

Požadavky

Nastavení

Použití fragmentů kódu

Cvičení

Cvičení 1: Vytvoření nového projektu Web Forms

Úkol 1 – vytvoření nového webu pomocí prostředí One ASP.NET

Úloha 2 – spuštění řešení

Cvičení 2: Vytvoření kontroleru MVC pomocí generování uživatelského rozhraní

Úkol 1 – vytvoření nového modelu

Úkol 2 – vytvoření kontroleru MVC

Úloha 3 – spuštění řešení

Cvičení 3: Vytvoření kontroleru webového rozhraní API pomocí generování uživatelského rozhraní

Úloha 1 – vytvoření kontroleru webového rozhraní API

Úloha 2 – spuštění řešení

Úloha 3 – přidání stránek nápovědy k webovému rozhraní API

Souhrn

Váš názor

Další materiály