азработка rest api и библиотека restforms · ―javascript (angularjs, react,...

Разработка REST API и библиотека RESTFormsЛебедюк Эдуард

InterSystems

2 | © InterSystems Corporation. All rights reserved. |

План

•Что такое REST

•Архитектура REST API

• Разработка

―Основы

―Отладка

―Тестирование и документирование

•Особенности―CORS

―Аутентификация

•RESTForms

Source: To add source, go to “Insert” tab, click on “Header & Footer”, check “Footer” and add the source information appropriate for the slide. (9pt)

Что такое REST


REST

• Стиль архитектуры программного обеспечения для распределенных систем.

• Как правило используется для построения веб-служб.

• Любые данные однозначно определяется URL – это значит, что URL по сути является первичным ключом для единицы данных.

https://server:80/webapp/book/:bookid


Принципы

• Разделение клиента и сервера

• Независимость от состояния (stateless)

• Кэшируемая и многоуровневая архитектура

• Единообразный интерфейс

• Все запросы к RESTful web API состоят из корневого URL

приложения плюс частные подзапросы

• CRUD (Create , Read, Update, Delete) через HTTP


Преимущества

•Независимость от языка/фреймворка/платформы―Клиенты на Java, JS, .Net и т.д.

•Легкость разработки―Проще чем SOAP

•Легковесность


Недостатки

• Привязан к протоколу HTTP

• Веб сервисы с более высокими требованиями сложно разрабатывать:

― Отсутствие стандартов обеспечения безопасности, политик, сообщений и т.д.


JSON

{

"firstName": "John",

"lastName": "Smith",

"address": {

"streetAddress": "21 2nd Street",

"city": "New York",

"state": "NY",

"postalCode": 10021

},

"phoneNumbers": [ "212 555-1212", "646 555-4567“ ]

}

• JavaScript Object Notation

― Малый размер

― Человекочитаемость

― Быстрота генерации и обработки

• Поддержка начиная с 2009.2

• Расширенная поддержка в ядре начиная с 2016.1


Взаимодействие

Ресурс GET PUT POST DELETE

Коллекция элементов

http://example.com/books

Получить список

URI элементов

коллекции,

возможно доп.

информацию.

Заменить

существующую

коллекцию на

новую.

Создать новый

элемент

коллекции.

Удалить

всю

коллекцию.

Один элемент коллекции

http://example.com/books/17

Получить всю

информацию об

элементе.

Обновить существующий

элемент.

Удалить

элемент

коллекции.

Корневая URL - http://example.com/


Поддержка REST

• Полная поддержка начиная с 2014.2

• Улучшения, ускоряющие и упрощающие разработку выходят с каждым релизом


Примеры REST API

MDX2JSON и клиент DeepSeeWeb


Примеры REST API

Ensemble Workflow и клиент Ensemble Workflow UI


RESTForms

•Проект для создания новых REST API с помощью обобщённого REST провайдера для хранимых классов

•Клиент на AngularJS

•Клиент на React

Архитектура REST API



Данные

Терминальное API

Web API

Клиент



• Взаимодействие с данными

• Данные не должны изменяться иначе, чем через это API

• Возвращают объекты или статус

• Не пишут на устройство


Web API

• Преобразуют входящий запрос в форму, понимаемую терминальным API

• Вызывают методы терминального API

• Отправка результата выполнения терминального API клиенту

• Не взаимодействуют с данными напрямую


Разделение API

• Терминальное API является основой логики приложения

• Функция Web API – преобразование запросов клиента в форму понятную терминальному API

и возврат клиенту результатов исполнения запроса

• Преимущества этого подхода:

― API выполняющие разные функции максимально разделены

― Возможна отладка вне веб-контекста



Данные


Web API

Клиент

Разработка


Брокеры

• Наследуются от %CSP.REST

• Содержит пути – сопоставления URI и вызываемых методов Caché

• Стандартный вид пути:

<Route

Url="/path/:param1/:param2"

Method="GET"

Call=“Package.Class:ClassMethod"

/>

• ClassMethod – любой метод класса Caché


Разделение брокеров

%CSP.REST

Абстрактный брокер

Брокер 1

Брокер 2

Брокер 3

• «Физическое» разделение брокеров по классам

• Абстрактный брокер – преобразование запросов, CORS и т.п.

• Брокер 1..N – выполнение запросов


Параметры брокера

Достаточно указать один раз в абстрактном брокере:

Parameter CONTENTTYPE = "application/json";

Parameter CHARSET = "UTF-8";

Parameter UseSession As BOOLEAN = 1;


Логическая иерархия брокеров

Главный брокер

Брокер версии

Брокер предметной области 1



Брокеры могут «передавать» запросы друг другу

<Map Prefix="/form" Forward="Destination.Broker"/>


Отладка

• REST клиент

• Перехватывающий прокси-сервер

• Анализатор трафика

Не надо:

• Использовать curl

• Использовать wget

• Использовать cli инструменты


Тестирование и документирование

• Соединены с визуальными средствами отладки

• Внешние средства

― Swagger

― Postman

― …

Демо

https://www.youtube.com/watch?v=Q7xqqKEwv7U

Особенности


CORS

• Cross-origin resource sharing (совместное использование ресурсов между разными

источниками) — технология современных браузеров, которая позволяет предоставить веб-

странице доступ к ресурсам другого домена.

• Parameter HandleCorsRequest = 1;

• ClassMethod OnHandleCorsRequest(pUrl As %String) As %Status {}

― Допустимый Origin – Host и IP сервера c клиентским веб-приложением


Аутентификация

• Во всех брокерах Parameter UseSession = 1;

• Все веб приложения доступны только с аутентификацией

• У всех веб приложений установлен таймаут сессии (900, 3600)

• У всех приложений установлено одно значение GroupById

• У всех приложений установлено одно значение Cookie Path

RESTForms


RESTForms

•Проект для создания новых REST API с помощью обобщённого REST провайдера для хранимых классов

•Работает начиная с 2016.1

•Цели проекта―Новые REST API без написания кода

―Минимальные изменения в хранимых классов


Use cases

У вас уже есть данные в Caché и вы хотите предоставить часть данных (или все) в

виде REST API

Вам нужно создать REST API для нового приложения


Архитектура приложения с использованием RESTForms

JS клиент RESTFormsДанные (классы)


Возможности

•CRUD над объектом

•R над коллекциями (через SQL)

•Работа с файлами

•CRUD над классом


Возможности

Метод URL Описание

GET form/info Список классов

GET form/info/all Метаинформация всех классов

GET form/info/:class Метаинформация одного класса

GET form/object/:class/:id Получить объект

GET form/object/:class/:id/:property Получить свойство объекта

POST form/object/:class Создать объект

PUT form/object/:class/:id Обновить объект из динамического объекта

PUT form/object/:class Обновить объект из объекта класса

DELETE form/object/:class/:id Удалить объект

GET form/objects/:class/:query Выполнить SQL запрос


Особенности

•JS работает сразу

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

•Примеры

•СПО, доступно на GitHub


RESTFormsUI

• Просмотр данных RESTForms

• Поддержка мобильных устройств

• Адаптивный дизайн

• Клиент на AnglularJS

• Клиент на React

Демо RESTForms + RESTFormsUI


RESTForms

• RESTForms упрощает создание нового REST API

• Пример организации REST API в части работы с данными и метаданными

• RESTForms – проверенная технология

― Ряд проектов с клиентами на AngularJS и React

― Примеры клиентов на GitHub

• RESTFormsUI позволяет сразу посмотреть на данные, предоставляемые RESTForms

Выводы


Выводы

• REST на сегодня – основная и общепринятая методика построения API для сети интернет

• Предоставляя REST API вы получаете возможность выбора из огромного набора технологий

построения приложений-клиентов:

― JavaScript (AngularJS, React, extJS, ...)

― Мобильные приложения (Cordova и подобные, Native)

• Технологии InterSystems позволяют вам с лёгкостью создавать REST API

Вопросы?

азработка rest api и библиотека restforms · ―javascript (angularjs, react,...

Documents