Протокол открытых данных

В вычислениях, Протокол открытых данных (OData ) - это открытый протокол, который позволяет создавать и использовать запрашиваемые и взаимодействующие REST API простым и стандартным способом. Microsoft инициировала OData в 2007 году. Версии 1.0, 2.0 и 3.0 выпущены в рамках Microsoft Open Specification Promise. Версия 4.0 была стандартизирована в OASIS с выпуском в марте 2014 года. В апреле 2015 года OASIS представил OData v4 и OData JSON Format v4 в ISO / IEC JTC 1 для утверждения в качестве международный стандарт.

Протокол позволяет создавать и использовать REST API, которые позволяют веб-клиентам публиковать и редактировать ресурсы, идентифицированные с помощью URL-адресов и определенные в модели данных, используя простые сообщения HTTP. OData имеет некоторые сходства с JDBC и с ODBC ; как и ODBC, OData не ограничивается реляционными базами данных.

• 1 Стандартизация
  • 1.1 Технический комитет OASIS OData
• 2 Архитектура
  • 2.1 Идентификация ресурсов
    • 2.1.1 Сервисный документ
    • 2.1.2 Документ метаданных
    • 2.1.3 Динамические ресурсы
  • 2.2 Операция с ресурсами
  • 2.3 Представление ресурса
    • 2.3.1 Пример полезной нагрузки данных OData JSON
    • 2.3.2 Пример OData Полезные данные Atom
    • 2.3.3 Пример документа метаданных OData
• 3 Экосистема
  • 3.1 Библиотеки
    • 3.1.1.NET
    • 3.1.2 Java
    • 3.1.3 JavaScript
    • 3.1.4 PHP
    • 3.1.5 Python
    • 3.1.6 Ruby
    • 3.1.7 Другое
  • 3.2 Приложения
• 4 Инструменты
• 5 См. Также
• 6 Ссылки
• 7 Внешние ссылки
  • 7.1 Стандарты OData OASIS
  • 7.2 Спецификации комитета
  • 7.3 Замечания комитета

После первоначальной разработки Microsoft OData стала стандартизированным протоколом Технического комитета OData OASIS (TC).

Технический комитет OASIS OData

«OASIS OData TC упрощает запросы и обмен данными между разрозненными приложениями и несколькими заинтересованными сторонами для повторного использования на предприятии, в облаке и на мобильных устройствах. REST- OData основывается на протоколе HTTP, AtomPub и JSON с использованием URI для адресации и доступа к ресурсам потока данных. Это позволяет информации быть доступными из различных источников, включая (но не ограничиваясь ими) реляционные базы данных, файловые системы, системы управления контентом и традиционные веб-сайты. OData предоставляет способ разбить разрозненные данные и повысить общую ценность данных путем создания экосистемы в какие потребители данных могут взаимодействовать с производителями данных гораздо более мощным способом, чем это возможно в настоящее время, позволяя большему количеству приложений понимать более широкий набор данных. Каждый производитель и потребитель данных, который участвует в этой экосистеме, увеличивает ее общую ценность ».

Среди участников TC CA Technologies, Citrix Systems, IBM, Microsoft, Progress Software, Red Hat, SAP SE и SDL.

OData - это протокол для создания и использования RESTful API. Таким образом, как обычная практика REST, OData основывается на HTTP, AtomPub и JSON, используя URI для адресации и доступа к ресурсам потока данных.

Идентификация ресурса

OData использует URI для идентификации ресурсов. Для каждой службы OData, корень службы которой сокращен как http: // host / service /, можно найти следующие фиксированные ресурсы:

Документ службы

В служебном документе перечислены наборы сущностей, функции и синглтоны, которые можно получить. Клиенты могут использовать служебный документ для навигации по модели в режиме гипермедиа.

Сервисный документ доступен по адресу http: // host / service /.

Документ метаданных

Документ метаданных описывает типы, наборы, функции и действия, понимаемые Служба OData. Клиенты могут использовать документ метаданных, чтобы понять, как запрашивать объекты в службе и взаимодействовать с ними.

Документ метаданных доступен по адресу http: // host / service / $ metadata.

Dynamic resources

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

Операция с ресурсами

OData использует команды HTTP для обозначения операций с ресурсами.

• GET: получить ресурс (набор сущностей, отдельную сущность, структурное свойство, свойство навигации, поток и т. Д.).
• POST: создать новый ресурс.
• PUT: обновить существующий ресурс, заменив его полным экземпляром.
• PATCH: обновить существующий ресурс, заменив часть его свойств частичным экземпляром.
• DELETE: удалить ресурс.

Представление ресурсов

OData использует разные форматы для представления данных и модели данных. В протоколе OData версии 4.0 формат JSON является стандартом для представления данных, а формат Atom все еще находится на стадии спецификации комитета. Для представления модели данных используется язык определения общей схемы (CSDL), который определяет XML-представление модели данных сущности, предоставляемой службами OData.

Пример полезной нагрузки данных OData JSON

Коллекция продуктов:

{"@ odata.context": "http://services.odata.org/V4/OData/OData.svc / $ metadata # Products "," value ": [{" ID ": 0," Name ":" Meat "," Description ":" Red Meat "," ReleaseDate ":" 1992-01-01T00: 00 : 00Z "," DiscontinuedDate ": null," Рейтинг ": 14," Цена ": 2.5}, {" ID ": 1," Name ":" Молоко "," Описание ":" Нежирное молоко "," Дата выпуска ":" 1995-10-01T00: 00: 00Z "," DiscontinuedDate ": null," Рейтинг ": 3," Цена ": 3.5},...]}

Пример полезной нагрузки данных OData Atom

Коллекция продуктов:

1 2 http://services.odata.org/v4/odata/odata.svc/Products3 4 2015-05-19T03 : 38: 50Z5 6 7 http://services.odata.org/V4/OData/OData.svc/Products(0)8 9 10 11 12 13 14 15 16