Поделиться через


Практическое лабораторное занятие. One ASP.NET: интеграция веб-форм ASP.NET, MVC и веб-API

по команде веб-лагерей

Скачивание комплекта обучения для веб-лагерей

ASP.NET — это платформа для создания веб-сайтов, приложений и служб с использованием специализированных технологий, таких как MVC, веб-API и другие. В связи с расширением ASP.NET наблюдается с момента его создания и выраженной необходимостью интеграции этих технологий, в последнее время предпринимаются усилия в направлении создания единой ASP.NET.

Visual Studio 2013 представляет новую унифицированную систему проектов, которая позволяет создавать приложения и использовать все технологии ASP.NET в одном проекте. Эта функция избавляет от необходимости выбирать одну технологию в начале проекта и придерживаться ее, а вместо этого поощряет использование нескольких платформ ASP.NET в рамках одного проекта.

Все примеры кода и фрагменты кода включены в комплект для обучения веб-лагерей, доступный по адресу https://aka.ms/webcamps-training-kit.

Общие сведения

Задачи

В этом практическом задании вы узнаете, как:

  • Создание веб-сайта на основе типа проекта One ASP.NET
  • Использование различных платформ ASP.NET , таких как MVC и веб-API , в одном проекте
  • Определение main компонентов приложения ASP.NET
  • Воспользуйтесь платформой формирования шаблонов ASP.NET для автоматического создания контроллеров и представлений для выполнения операций CRUD на основе классов модели.
  • Предоставление одного и того же набора сведений в машинном и удобочитаемом формате с помощью правильного средства для каждого задания

Предварительные требования

Для выполнения этого практического задания требуется следующее:

Настройка

Чтобы выполнить упражнения в этом практическом задании, сначала необходимо настроить среду.

  1. Откройте Windows Обозреватель и перейдите в папку Source лаборатории.
  2. Щелкните правой кнопкой мыши Setup.cmd и выберите Запуск от имени администратора , чтобы запустить процесс установки, который настроит среду и установит фрагменты кода Visual Studio для этого задания.
  3. Если отображается диалоговое окно Контроль учетных записей, подтвердите действие для продолжения.

Примечание

Перед запуском программы установки убедитесь, что вы проверили все зависимости для этой лаборатории.

Использование фрагментов кода

Во всем лабораторном документе вам будет предложено вставить блоки кода. Для удобства большая часть этого кода предоставляется в виде фрагментов Visual Studio Code, доступ к которым можно получить из Visual Studio 2013, чтобы избежать необходимости добавлять его вручную.

Примечание

Каждое упражнение сопровождается начальным решением, расположенным в папке Begin упражнения, которое позволяет выполнять каждое упражнение независимо от других. Имейте в виду, что фрагменты кода, добавленные во время упражнения, отсутствуют в этих начальных решениях и могут не работать, пока вы не завершите упражнение. В исходном коде упражнения вы также найдете папку End , содержащую решение Visual Studio с кодом, который является результатом выполнения шагов в соответствующем упражнении. Эти решения можно использовать в качестве руководства, если вам нужна дополнительная помощь при работе с этим практическим занятием.


Упражнения

Это практическое занятие включает в себя следующие упражнения:

  1. Создание нового проекта веб-формы
  2. Создание контроллера MVC с помощью формирования шаблонов
  3. Создание контроллера веб-API с помощью формирования шаблонов

Предполагаемое время выполнения этого задания: 60 минут

Примечание

При первом запуске Visual Studio необходимо выбрать одну из стандартных коллекций параметров. Каждая предопределенная коллекция предназначена для соответствия определенному стилю разработки и определяет макеты окон, поведение редактора, фрагменты кода IntelliSense и параметры диалоговых окон. Процедуры в этом задании описывают действия, необходимые для выполнения данной задачи в Visual Studio при использовании коллекции Общих параметров разработки . Если выбрать другую коллекцию параметров для среды разработки, возможны различия в действиях, которые следует учитывать.

Упражнение 1. Создание нового проекта веб-формы

В этом упражнении вы создадите новый сайт веб-формы в Visual Studio 2013 с помощью единого интерфейса проекта One ASP.NET, что позволит легко интегрировать компоненты веб-формы, MVC и веб-API в одном приложении. Затем вы изучите созданное решение и определите его части, и, наконец, увидите веб-сайт в действии.

Задача 1. Создание нового сайта с помощью интерфейса one ASP.NET

В этой задаче вы начнете создавать веб-сайт в Visual Studio на основе типа проекта One ASP.NET . Один ASP.NET объединяет все ASP.NET технологии и дает возможность сочетать и сопоставлять их по желанию. Затем вы узнаете о различных компонентах веб-формы, MVC и веб-API, которые живут параллельно в приложении.

  1. Откройте Visual Studio Express 2013 для Интернета и выберите Файл | Создать проект... для запуска нового решения.

    Создание нового проекта

    Создание нового проекта

  2. В диалоговом окне Новый проект выберите ASP.NET веб-приложение в разделе Visual C# | Вкладка Веб и убедитесь, что выбран платформа .NET Framework 4.5. Присвойте проекту имя MyHybridSite, выберите Расположение и нажмите кнопку ОК.

    Новый проект веб-приложения ASP.NET

    Создание проекта веб-приложения ASP.NET

  3. В диалоговом окне Новый проект ASP.NET выберите шаблон веб-формы и выберите параметры MVC и Веб-API. Кроме того, убедитесь, что для параметра Проверка подлинности задано значение Индивидуальные учетные записи пользователей. Чтобы продолжить, нажмите кнопку ОК .

    Создание проекта с помощью шаблона веб-формы, включая веб-API и компоненты MVC

    Создание проекта с помощью шаблона веб-формы, включая веб-API и компоненты MVC

  4. Теперь вы можете изучить структуру созданного решения.

    Изучение созданного решения

    Изучение созданного решения

    1. Учетной записи: Эта папка содержит страницы веб-форм для регистрации, входа в учетные записи пользователей приложения и управления ими. Эта папка добавляется при выборе параметра проверки подлинности отдельных учетных записей пользователей во время настройки шаблона проекта веб-формы.
    2. Модели: Эта папка будет содержать классы, представляющие данные приложения.
    3. Контроллеры и представления. Эти папки необходимы для ASP.NET компонентов MVC и веб-API ASP.NET. В следующих упражнениях вы изучите технологии MVC и веб-API.
    4. Файлы Default.aspx, Contact.aspx и About.aspx — это предварительно определенные страницы веб-формы, которые можно использовать в качестве отправных точек для создания страниц, относящихся к вашему приложению. Логика программирования этих файлов находится в отдельном файле, называемом файлом "код программной части", который имеет расширение ".aspx.vb" или .aspx.cs" (в зависимости от используемого языка). Логика кода программной части выполняется на сервере и динамически создает выходные данные HTML для вашей страницы.
    5. Страницы Site.Master и Site.Mobile.Master определяют внешний вид и стандартное поведение всех страниц в приложении.
  5. Дважды щелкните файл Default.aspx , чтобы просмотреть содержимое страницы.

    Изучение страницы Default.aspx

    Изучение страницы Default.aspx

    Примечание

    Директива Page в верхней части файла определяет атрибуты веб-формы страницы. Например, атрибут MasterPageFile указывает путь к странице master( в данном случае это страница Site.Master), а атрибут Inherits определяет класс кода программной части для наследуемой страницы. Этот класс находится в файле, определяемом атрибутом CodeBehind .

    Элемент управления asp:Content содержит фактическое содержимое страницы (текст, разметка и элементы управления) и сопоставляется с элементом управления asp:ContentPlaceHolder на странице master. В этом случае содержимое страницы будет отображаться внутри элемента управления MainContent , определенного на странице Site.Master .

  6. Разверните папку App_Start и обратите внимание на файл WebApiConfig.cs . Visual Studio включила этот файл в созданное решение, так как вы включили веб-API при настройке проекта с помощью шаблона One ASP.NET.

  7. Откройте файл WebApiConfig.cs . В классе WebApiConfig вы найдете конфигурацию, связанную с веб-API, которая сопоставляет маршруты HTTP с контроллерами веб-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 }
            );
    }
    
  8. Откройте файл RouteConfig.cs . В методе RegisterRoutes вы найдете конфигурацию, связанную с MVC, которая сопоставляет маршруты HTTP с контроллерами 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 }
            );
    }
    

Задача 2. Запуск решения

В этой задаче вы запустите созданное решение, изучите приложение и некоторые его функции, такие как переопределение URL-адресов и встроенная проверка подлинности.

  1. Чтобы запустить решение, нажмите клавишу F5 или нажмите кнопку Пуск на панели инструментов. Домашняя страница приложения должна открыться в браузере.

    Запуск решения

  2. Убедитесь, что вызываются веб-формы страницы. Для этого добавьте /contact.aspx к URL-адресу в адресной строке и нажмите клавишу ВВОД.

    Понятные URL-адреса

    Понятные URL-адреса

    Примечание

    Как видите, URL-адрес изменится на /contact. Начиная с ASP.NET 4 в веб-формы были добавлены возможности маршрутизации URL-адресов, поэтому вместо можно писать URL-адреса, например http://www.mysite.com/products/softwarehttp://www.mysite.com/products.aspx?category=software. Дополнительные сведения см. в статье Маршрутизация URL-адресов.

  3. Теперь вы изучите поток проверки подлинности, интегрированный в приложение. Для этого нажмите кнопку Зарегистрировать в правом верхнем углу страницы.

    Регистрация нового пользователя

    Регистрация нового пользователя

  4. На странице Регистрация введите имя пользователя и пароль, а затем нажмите кнопку Зарегистрировать.

    Страница регистрации

    Страница регистрации

  5. Приложение регистрирует новую учетную запись, и пользователь проходит проверку подлинности.

    Пользователь прошел проверку подлинности

    Пользователь прошел проверку подлинности

  6. Назад в Visual Studio и нажмите клавиши SHIFT+F5, чтобы остановить отладку.

Упражнение 2. Создание контроллера MVC с помощью формирования шаблонов

В этом упражнении вы будете использовать платформу формирования шаблонов ASP.NET, предоставляемую Visual Studio, для создания контроллера ASP.NET MVC 5 с действиями и представлениями Razor для выполнения операций CRUD без написания ни одной строки кода. Процесс формирования шаблонов будет использовать Entity Framework Code First для создания контекста данных и схемы базы данных в базе данных SQL.

Сведения о Entity Framework Code First

Entity Framework (EF) — это объектно-реляционный сопоставителя (ORM), который позволяет создавать приложения для доступа к данным путем программирования с помощью концептуальной модели приложений, а не непосредственно с помощью схемы реляционного хранилища.

Рабочий процесс моделирования Entity Framework Code First позволяет использовать собственные классы предметной области для представления модели, которая используется EF при выполнении запросов, отслеживания изменений и обновления функций. Используя рабочий процесс разработки Code First, вам не нужно начинать приложение с создания базы данных или указания схемы. Вместо этого можно написать стандартные классы .NET, которые определяют наиболее подходящие объекты модели предметной области для приложения, и Entity Framework создаст базу данных.

Примечание

Дополнительные сведения о Entity Framework см. здесь.

Задача 1. Создание новой модели

Теперь вы определите класс Person , который будет моделью, используемой процессом формирования шаблонов для создания контроллера MVC и представлений. Вы начнете с создания класса модели Person , и операции CRUD в контроллере будут автоматически созданы с помощью функций формирования шаблонов.

  1. Откройте Visual Studio Express 2013 для Интернета и решение MyHybridSite.sln, расположенное в папке Source/Ex2-MvcScaffolding/Begin. Кроме того, можно продолжить работу с решением, полученным в предыдущем упражнении.

  2. В Обозреватель решений щелкните правой кнопкой мыши папку Models проекта MyHybridSite и выберите Добавить | Класс....

    Добавление класса модели Person

    Добавление класса модели Person

  3. В диалоговом окне Добавление нового элемента назовите файл Person.cs и нажмите кнопку Добавить.

    Создание класса модели Person

    Создание класса модели Person

  4. Замените содержимое файла Person.cs следующим кодом. Нажмите клавиши CTRL+S , чтобы сохранить изменения.

    (Фрагмент кода — BringingTogetherOneAspNet — Ex2 — PersonClass)

    namespace MyHybridSite.Models
    {
        public class Person
        {
            public int Id { get; set; }
    
            public string Name { get; set; }
    
            public int Age { get; set; }
        }
    }
    
  5. В Обозреватель решений щелкните правой кнопкой мыши проект MyHybridSite и выберите Сборка или нажмите клавиши CTRL+SHIFT+B, чтобы выполнить сборку проекта.

Задача 2. Создание контроллера MVC

Теперь, когда модель Person создана, вы будете использовать ASP.NET формирования шаблонов MVC с Entity Framework для создания действий и представлений контроллера CRUD для Person.

  1. В Обозреватель решений щелкните правой кнопкой мыши папку Controllers проекта MyHybridSite и выберите Добавить | Новый шаблонный элемент....

    Снимок экрана: создание контроллера MVC путем выбора нового элемента с шаблоном в Обозреватель решений.

    Создание нового шаблонного контроллера

  2. В диалоговом окне Добавление шаблона выберите Контроллер MVC 5 с представлениями с помощью Entity Framework и нажмите кнопку Добавить.

    Выбор контроллера MVC 5 с представлениями и Entity Framework

    Выбор контроллера MVC 5 с представлениями и Entity Framework

  3. Задайте MvcPersonController в качестве имени контроллера, выберите параметр Использовать асинхронные действия контроллера и выберите Person (MyHybridSite.Models) в качестве класса Model.

    Добавление контроллера MVC с формированием шаблонов

    Добавление контроллера MVC с формированием шаблонов

  4. В разделе Класс контекста данных щелкните Создать контекст данных....

    Создание нового контекста данных

    Создание нового контекста данных

  5. В диалоговом окне Новый контекст данных присвойте новому контексту данных имя PersonContext и нажмите кнопку Добавить.

    Создание объекта PersonContext

    Создание нового типа PersonContext

  6. Нажмите кнопку Добавить , чтобы создать контроллер для пользователя с формированием шаблонов. Затем Visual Studio создаст действия контроллера, контекст данных Person и представления Razor.

    После создания контроллера MVC с формированием шаблонов

    После создания контроллера MVC с формированием шаблонов

  7. Откройте файл MvcPersonController.cs в папке Controllers . Обратите внимание, что методы действий 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);
    }
    
    ...
    

    Примечание

    Выбрав поле Использовать действия асинхронного контроллера проверка из параметров формирования шаблонов на предыдущих шагах, Visual Studio создает асинхронные методы действий для всех действий, связанных с доступом к контексту данных Person. Рекомендуется использовать асинхронные методы действий для длительных запросов, не привязанных к ЦП, чтобы избежать блокирования веб-сервера от выполнения работы во время обработки запроса.

Задача 3. Запуск решения

В этой задаче вы снова запустите решение, чтобы убедиться, что представления для person работают должным образом. Вы добавите нового пользователя, чтобы убедиться, что он успешно сохранен в базе данных.

  1. Чтобы запустить решение, нажмите клавишу F5.

  2. Перейдите к /MvcPerson. Должно появиться представление с шаблонами, в которое должен отобразиться список людей.

  3. Нажмите кнопку Создать, чтобы добавить нового пользователя.

    Переход к шаблонам представлений MVC

    Переход к шаблонам представлений MVC

  4. В представлении Создать укажите имя и возраст пользователя, а затем нажмите кнопку Создать.

    Добавление нового пользователя

    Добавление нового пользователя

  5. Новый пользователь будет добавлен в список. В списке элементов щелкните Сведения , чтобы отобразить представление сведений о пользователе. Затем в представлении Сведения нажмите кнопку Назад к списку , чтобы вернуться в представление списка.

    Представление сведений о пользователе

    Представление сведений о пользователе

  6. Щелкните ссылку Удалить , чтобы удалить пользователя. В представлении Удалить нажмите кнопку Удалить , чтобы подтвердить операцию.

    Удаление пользователя

    Удаление пользователя

  7. Назад в Visual Studio и нажмите клавиши SHIFT+F5, чтобы остановить отладку.

Упражнение 3. Создание контроллера веб-API с помощью формирования шаблонов

Платформа веб-API является частью ASP.NET Stack и предназначена для упрощения реализации служб HTTP, как правило, отправки и получения данных в формате JSON или XML через RESTful API.

В этом упражнении вы снова будете использовать ASP.NET формирования шаблонов для создания контроллера веб-API. Вы будете использовать те же классы Person и PersonContext из предыдущего упражнения, чтобы предоставить одни и те же данные пользователя в формате JSON. Вы увидите, как можно предоставлять одни и те же ресурсы различными способами в одном ASP.NET приложении.

Задача 1. Создание контроллера веб-API

В этой задаче вы создадите новый контроллер веб-API , который будет предоставлять данные о пользователях в машинном формате, например JSON.

  1. Если он еще не открыт, откройте Visual Studio Express 2013 для Интернета и откройте решение MyHybridSite.sln, расположенное в папке Source/Ex3-WebAPI/Begin. Кроме того, можно продолжить работу с решением, полученным в предыдущем упражнении.

    Примечание

    Если вы начинаете с начального решения из упражнения 3, нажмите клавиши CTRL+SHIFT+B , чтобы выполнить сборку решения.

  2. В Обозреватель решений щелкните правой кнопкой мыши папку Controllers проекта MyHybridSite и выберите Добавить | Новый шаблонный элемент....

    Снимок экрана: создание контроллера веб-API путем выбора нового элемента с шаблоном в Обозреватель решений.

    Создание нового шаблонного контроллера

  3. В диалоговом окне Добавление шаблона выберите Веб-API в области слева, а затем Контроллер Веб-API 2 с действиями, используя Entity Framework в средней области, и нажмите кнопку Добавить.

    Выбор контроллера веб-API 2 с действиями и Entity Framework

    Выбор контроллера веб-API 2 с действиями и Entity Framework

  4. Задайте ApiPersonController в качестве имени контроллера, выберите параметр Использовать асинхронные действия контроллера и выберите Person (MyHybridSite.Models) и PersonContext (MyHybridSite.Models) в качестве классов контекста модели и данных соответственно. Нажмите кнопку Добавить.

    Добавление контроллера веб-API с формированием шаблонов

    Добавление контроллера веб-API с формированием шаблонов

  5. Затем Visual Studio создаст класс ApiPersonController с четырьмя действиями CRUD для работы с данными.

    После создания контроллера веб-API с формированием шаблонов

    После создания контроллера веб-API с формированием шаблонов

  6. Откройте файл ApiPersonController.cs и проверьте метод действия GetPeople . Этот метод запрашивает поле базы данных типа PersonContext , чтобы получить данные о людях.

    // GET api/ApiPerson
    public IQueryable<Person> GetPeople()
    {
        return db.People;
    }
    
  7. Теперь обратите внимание на комментарий над определением метода. Он предоставляет универсальный код ресурса (URI), который предоставляет это действие, которое будет использоваться в следующей задаче.

    // GET api/ApiPerson
    public IQueryable<Person> GetPeople()
    {
        return db.People;
    }
    

    Примечание

    По умолчанию веб-API настроен для перехвата запросов по пути /api , чтобы избежать конфликтов с контроллерами MVC. Если вам нужно изменить этот параметр, см. раздел Маршрутизация в веб-API ASP.NET.

Задача 2. Запуск решения

В этой задаче вы будете использовать средства разработчика F12 для Интернета Обозреватель для проверки полного ответа от контроллера веб-API. Вы увидите, как можно собирать сетевой трафик, чтобы получить дополнительные сведения о данных приложения.

Примечание

Убедитесь, что Обозреватель Интернета выбран на кнопке Пуск, расположенной на панели инструментов Visual Studio.

Параметр Обозреватель Интернета

Средства разработчика F12 имеют широкий набор функциональных возможностей, которые не рассматриваются в этой практической лаборатории. Дополнительные сведения см. в статье Использование средств разработчика F12.

  1. Чтобы запустить решение, нажмите клавишу F5.

    Примечание

    Для правильного выполнения этой задачи приложение должно иметь данные. Если база данных пуста, можно вернуться к задаче 3 в упражнении 2 и выполнить действия по созданию нового пользователя с помощью представлений MVC.

  2. В браузере нажмите клавишу F12 , чтобы открыть панель Средства разработчика . Нажмите клавиши CTRL + 4 или щелкните значок Сеть , а затем нажмите зеленую кнопку со стрелкой, чтобы начать запись сетевого трафика.

    Инициализация записи сети веб-API

    Инициализация сетевого захвата веб-API

  3. Добавьте api/ApiPerson к URL-адресу в адресной строке браузера. Теперь вы проверите сведения об ответе от ApiPersonController.

    Получение данных о пользователях через веб-API

    Получение данных о пользователях с помощью веб-API

    Примечание

    После завершения скачивания вам будет предложено выполнить действие с скачанным файлом. Оставьте диалоговое окно открытым, чтобы watch содержимое ответа в окне Средства разработчиков.

  4. Теперь вы проверите текст ответа. Для этого откройте вкладку Сведения и выберите текст ответа. Вы можете проверка, что загруженные данные являются списком объектов со свойствами Id, Name и Age, которые соответствуют классу Person.

    Просмотр текста ответа веб-API

    Просмотр текста ответа веб-API

Задача 3. Добавление страниц справки веб-API

При создании веб-API полезно создать страницу справки, чтобы другие разработчики знали, как вызывать его. Вы можете создать и обновить страницы документации вручную, но лучше создать их автоматически, чтобы избежать необходимости выполнять обслуживание. В этой задаче вы будете использовать пакет NuGet для автоматического создания страниц справки веб-API для решения.

  1. В меню Сервис в Visual Studio выберите Диспетчер пакетов NuGet, а затем щелкните Консоль диспетчера пакетов.

  2. В окне консоли диспетчера пакетов выполните следующую команду:

    Install-Package Microsoft.AspNet.WebApi.HelpPage
    

    Примечание

    Пакет Microsoft.AspNet.WebApi.HelpPage устанавливает необходимые сборки и добавляет представления MVC для страниц справки в папке Areas/HelpPage .

    Область helpPage

    Область HelpPage

  3. По умолчанию страницы справки содержат строки заполнителей для документации. Для создания документации можно использовать комментарии XML-документации. Чтобы включить эту функцию, откройте файл HelpPageConfig.cs , расположенный в папке Areas/HelpPage/App_Start , и раскомментируйте следующую строку:

    config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/XmlDocument.xml")));
    
  4. В Обозреватель решений щелкните правой кнопкой мыши проект MyHybridSite, выберите Свойства и перейдите на вкладку Сборка.

    Раздел

    Вкладка "Сборка"

  5. В разделе Выходные данные выберите XML-файл документации. В поле ввода введите App_Data/XmlDocument.xml.

    Раздел

    Раздел "Выходные данные" на вкладке "Сборка"

  6. Нажмите клавиши CTRL + S , чтобы сохранить изменения.

  7. Откройте файл ApiPersonController.cs из папки Controllers .

  8. Введите новую строку между сигнатурой метода GetPeople и комментарием // GET api/ApiPerson , а затем введите три косые черты.

    Примечание

    Visual Studio автоматически вставляет XML-элементы, определяющие документацию по методу.

  9. Добавьте текст сводки и возвращаемое значение для метода GetPeople . Это должно выглядеть примерно так.

    // 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;
    }
    
  10. Чтобы запустить решение, нажмите клавишу F5.

  11. Добавьте /help к URL-адресу в адресной строке, чтобы перейти на страницу справки.

    Страница справки веб-API ASP.NET

    Страница справки веб-API ASP.NET

    Примечание

    Main содержимое страницы — это таблица API, сгруппированных по контроллеру. Записи таблицы создаются динамически с помощью интерфейса IApiExplorer . При добавлении или обновлении контроллера API таблица будет автоматически обновлена при следующей сборке приложения.

    В столбце API перечислены метод HTTP и относительный URI. Столбец Описание содержит сведения, извлеченные из документации по методу.

  12. Обратите внимание, что описание, добавленное над определением метода, отображается в столбце description.

    Описание метода API

    Описание метода API

  13. Щелкните один из методов API, чтобы перейти на страницу с более подробными сведениями, включая примеры текста ответа.

    Страница подробных сведений

    Страница с подробными сведениями


Итоги

Пройдя эту практическую работу, вы узнали, как выполнять следующие задачи:

  • Создание веб-приложения с помощью интерфейса One ASP.NET в Visual Studio 2013
  • Интеграция нескольких технологий ASP.NET в один проект
  • Создание контроллеров и представлений MVC из классов модели с помощью ASP.NET формирования шаблонов
  • Создание контроллеров веб-API, которые используют такие функции, как асинхронное программирование и доступ к данным через Entity Framework.
  • Автоматическое создание страниц справки веб-API для контроллеров