Skip to content
develop-v5.2
Go to file
Code

README.md

Flexberry ORM ODataService

Build Status Master

Build Status Develop

В этом репозитории располагается исходный код Flexberry ORM ODataService - серверного компонета для реализации публикации данных по протоколу OData V4 для Microsoft .NET Framework.

Ключевые особенности

  • Возможность публикации модели данных Flexberry ORM без необходимости доработки или генерации кода - достаточно иметь скомпилированную сборку с объектами данных.
  • Широкие возможности по кастомизации, включая возможность управления запросами, передаваемыми в Flexberry ORM.
  • Поддержка Mono (отсутствие неуправляемого кода).

Использование

Для работы с Flexberry ORM ODataService требуется наличие сборки с объектами данных Flexberry ORM. OData-сервер работает поверх WebApi, поэтому конфигурация выполняется в соответствующем стиле. Подробнее с конфигурацией можно познакомиться в документации.

Структура проекта

Данное решение содержит несколько проектов, которые можно условно разделить две категории:

  • Реализация OData-сервера
    • NewPlatform.Flexberry.ORM.ODataService - основной проект, в котором располагаются классы для публикации с объектов данных по протоколу OData.
  • Проекты для тестов
    • NewPlatform.Flexberry.ORM.ODataService.Tests - проект с интеграционными тестами (для их исполнения требуются различные СУБД).
    • NewPlatform.Flexberry.ORM.ODataService.Tests(Objects) - объекты для проекта с тестами
    • NewPlatform.Flexberry.ORM.ODataService.Tests(BusinessServers) - бизнес-логика объектов проекта с тестами.

Тестирование

Реализованы интеграционные тесты. Для выполнения интеграционных тестов требуется наличие СУБД: Microsoft SQL, Postgres, Oracle. Соответствующие строки соединения задаются в конфигурационном файле проекта с интеграционными тестами. При выполнении тестов для каждого тестового метода создаётся временная БД (скрипты есть в проекте с интеграционными тестами). Структура данных для тестов сгенерирована при помощи Flexberry Designer, метаданные выгружены в виде crp-файла.

Документация

Документация разработчика размещается в разделе Flexberry ORM на сайте https://flexberry.github.io. Автогенерируемая документация по API размещается в ветке gh-pages и доступна пользователям по адресу: https://flexberry.github.io/NewPlatform.Flexberry.ORM.ODataService/autodoc/develop/

Сообщество

Основным способом распространения Flexberry ORM ODataService является NuGet-пакет. Если во время использования этого фреймворка вы обнаружили ошибку или проблему, то можно завести Issue или исправить ошибку и отправить в этот репозиторий соответствующий Pool Request.

Доработка

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

Техническая поддержка

Авторы оставляют за собой право выполнять доработки и исправление ошибок самостоятельно без каких-либо гарантий по срокам. В случае необходимости получения приоритетной технической поддержки с фиксированными сроками, то условия проведения данной работы можно обговорить в частном порядке по E-Mail.

Ссылки