Заметки консультанта

Шамрай Александр Владимирович

Практическое руководство по отчетности TFS. Open Data Protocol (OData)

Posted by Шамрай Александр на Декабрь 11, 2013

Что это такое?

Протокол Open Data Protocol (OData) — веб-протокол для запроса и обновления данных, который предоставляет метод для разблокировки ваших данных и возможность избавить их от хранилищ, которые сегодня существуют в приложениях. OData делает это с применением веб-технологий, таких как HTTP, Atom Oublishing Protocol(AtomPub) и JSON, для обеспечения доступа к информации из различных приложений, услуг и хранилищ.

Протокол является опытом реализации клиентов и серверов AtomPub в различных продуктах за последние несколько лет. OData помогает нам представить и обеспечить доступ к информации из различных источников, включая, но не ограничиваясь, реляционные базы данных, файловые систем, системы управления контентом и традиционные веб-сайтов.

Зачем его использовать?

В настоящее время в интернете существуют общие пути проектирования Application Programming Interfaces (API) веб-приложений. Многие из них применяют принципы REST или CQRS и используют JSON или XML для предоставления данных.

Часто задаваемые вопросы:

  • Что означает сделать POST к конкретному ресурсу?
  • Что необходимо для идентификации связанных ресурсов?
  • Возможно ли применять фильтры для извлечения определенных ресурсов?

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

OData решает эту проблему, предоставляя единый метод представления, структурирования, запроса и манипулирования данными с использованием практик REST и синтаксиса JSON или ATOM для описания полезных данных.

OData также предоставляет универсальный способ для представления метаданных о данных, позволяя компьютерам узнать больше о системе типов, взаимосвязях и структуре данных.

С помощью OData вы окунетесь в большую экосистему, которая будет направлена на ваш набор данных, без необходимости длительного изучения перед началом работы с данными.

Настройка TfsOData

Мы используем решения OData, опубликованное Брайаном Келлером, которое можно загрузить с здесь.

Примечание

При использовании https://tfs.visualstudio.com, OData включен по умолчанию. Если у вас нет планов настройки потока OData, этот раздел будет вам только для информации. Для получения более подробной информации см. Bringing OData to Team Foundation Service.

Примечание

При использовании ALM VM TFS 2012 (http://aka.ms/almvms) Брайана Келлера, вам необходимо убедиться, что у вас в наличии свежая виртуальная машина и что включена синхронизация времени, в противном случае вы не сможете подключиться к каналу размещенной службы odata из-за ошибки сертификата. Вам также нужно будет включить доступ в Интернет.

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

Сборка сервисов OData
Развертывание сервисов OData
Сторонние решения
  • Служба OData использует WCF Data Services Toolkit, чтобы обеспечить общие задачи, связанных со сборкой конечной точки OData со службой данных WCF. Эта зависимость расположена в папке code\References.
  • Проект ODataTFS.Tests, который содержит модульные тесты, зависит от библиотеки с названием Moq. Версия 4.0 этой зависимости включена как часть загрузки службы OData.

Таблица 1. Предварительные требования

Примечание

Если вы хотите запускать или отлаживать с помощью эмулятора Azure, вам также нужно будет установить IIS с возможностью ASP.NET на компьютере разработчика.

Развертывание служб OData на сервере IIS

Примечание

Это руководство было проверено на Windows Server 2008 R2 Standard SP1, Windows Server 2012 Standard и в Windows Server 2012 R2. Вам может потребоваться адаптировать его в соответствии с вашей средой, если есть какие-либо различия.
Шаг Описание
1. Установить роль Web Server (IIS)

[ ] — Сделано

  • Установить роль Web Server (IIS) и включить службы роли ASP.NET.
  • Добавить зависимые службы при появлении соответствующего запроса. В Server 2012 этот выбор будет включать Application Development | ASP.NET 4.5.
  • Включить параметр Dynamic Content Compression.
2. Установить NET Framework 4.5

[ ] — Сделано

  • Это является предварительным условием для клиентской объектной модели Team Foundation Server.
  • На сервере 2012 это условие является частью ASP.NET 4.5.
Примечание Если платформа .NET Framework установлена до IIS, необходимо использовать средство регистрации IIS для ASP.NET, которое поставляется с платформой.
  • Рекомендуется проверить наличие обновлений Windows после установки NET Framework.
3. Собрать OData для сервера

[ ] — Сделано

  • Откройте файл решения ODataTFS.sln в Visual Studio
  • Если у вас уже установлен пакет SDK Azure, перейдите к следующему разделу.
  • Если вы хотите избежать установки Azure SDK и в конечном итоге будете выполнять развертывание в IIS, вы можете просто удалить ссылки Microsoft.WindowsAzure.* из веб-проекта.

  • Выберите Build | Rebuild Solution, чтобы убедиться, что все обновлено.
4. Опубликовать OData

[ ] — Сделано

  • Щелкните правой кнопкой мыши на проекте ODataTFS.Web в обозревателе решений и выберите Publish.
  • Вы можете использовать любой метод публикации, который вы хотите, но оставшиеся инструкции в разделе основаны на методе публикации в файловой системе.

5. Скопировать опубликованный веб-сайт на сервер

[ ] — Сделано

  • Запустите скрипт InstallTFSObjectModel.cmd из папки \bin\SetupFiles опубликованного веб-сайта. Это позволит установить сборки клиентской объектной модели Team Foundation Server в глобальный кэш сборок.
  • Запустите скрипт SetupIIS.cmd из папки \bin\SetupFiles опубликованного веб-сайта для создания папки кэша клиентской объектной модели Team Foundation Server и установки разрешений для группы IIS_IUSRS для папки кэша.
6. Настроить безопасность

[ ] — Сделано

  • Убедитесь, что группа IIS_IUSRS также имеет все разрешения в это место, через командную строку или через свойства папки и вкладку Безопасность в окне проводника Windows.
  • Создайте и настройте новый веб-сайт в IIS. Установить основные настройки сайта, такие как имя, порт и имя хоста, для вашей конкретной среды.
  • Убедитесь, что вы используете HTTPS и SSL-сертификат для привязки.
  • Предпочтительно использовать физический путь c:\Inetpub\wwwroot\TfsOdataAlmRangers, вместо c:\odata.

Примечание

Для тестирования, можно использовать самозаверяющийся сертификат. Один из способов сделать это, с использованием IIS Manager перейти в узел машины, открыть Server Certificates и выбрать Create Self-Signed Certificate. Чтобы узнать больше о SSL и IIS, смотрите http://learn.iis.net/page.aspx/144/how-to-set-up-ssl-on-iis-7/
7. Настройте .NET Framework

[ ] — Сделано

После того, как был создан веб-сайт, мы также должны убедиться, что соответствующий пул приложений настроен на использование .NET Framework 4. Будет нормально, если дополнительный номер версии больше чем показанный на скриншоте.

8. Готово!

[ ] — Сделано

С этого момента сервисы OData готовы к использованию.

Таблица 2. Руководство: Развертывание служб OData на сервере IIS

Реклама

Добавить комментарий

Заполните поля или щелкните по значку, чтобы оставить свой комментарий:

Логотип WordPress.com

Для комментария используется ваша учётная запись WordPress.com. Выход / Изменить )

Фотография Twitter

Для комментария используется ваша учётная запись Twitter. Выход / Изменить )

Фотография Facebook

Для комментария используется ваша учётная запись Facebook. Выход / Изменить )

Google+ photo

Для комментария используется ваша учётная запись Google+. Выход / Изменить )

Connecting to %s

 
%d такие блоггеры, как: