УСПОКОИТЕЛЬНЫЙ API

УСПОКОИТЕЛЬНЫЙ API использует модель ответа запроса Протокола передачи гипертекста (HTTP) для связи с MATLAB^® Production Server™. Эта модель включает методы запроса, коды ответа, заголовки сообщения и тексты сообщений. УСПОКОИТЕЛЬНЫЙ API имеет следующие характеристики:

Методы HTTP — POST, GET и DELETE — формируют первичный режим из связи между клиент-сервером.
Ресурсы, созданные сервером, однозначно определяются с помощью Унифицированных идентификаторов ресурса (URIs).
Метаданные, такие как content-type запроса передаются через заголовок сообщения. Единственным поддерживаемым типом контента является application/json.
Входные параметры к функции MATLAB, содержавшей в развернутом архиве, представляются в JSON и инкапсулируются в теле сообщения.
Текст сообщения ответа содержит информацию о запросе, таком как состояние или результаты.
Это поддерживает и синхронное и асинхронные режимы сервера.

API

Ввод	Цель
Синхронное выполнение	Выполните синхронные запросы к серверу
Асинхронное выполнение	Выполните асинхронные запросы к серверу
Сервис открытия	Узнайте функции MATLAB, развернутые на сервере

Ввод

Цель

Синхронное выполнение

Выполните синхронные запросы к серверу

Асинхронное выполнение

Выполните асинхронные запросы к серверу

Сервис открытия

Узнайте функции MATLAB, развернутые на сервере

Синхронное выполнение

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

УСПОКОИТЕЛЬНЫЕ вызовы API синхронного режима

Вызвать	Цель
`POST Synchronous Request`	Выполните синхронный запрос к серверу и ожидайте ответа

Следующая диаграмма иллюстрирует, как УСПОКОИТЕЛЬНЫЙ API работает в синхронном режиме.

Пример: синхронное выполнение магического квадрата Используя УСПОКОИТЕЛЬНЫЙ API и JSON

Этот пример показывает, как использовать УСПОКОИТЕЛЬНЫЙ API и JSON путем обеспечения двух отдельных реализаций — одно использование JavaScript^® и другое использование Python^® . Когда вы выполняете этот пример, сервер возвращает список 25 разделенных от запятой значений. Этими значениями является вывод развернутой функции MATLAB mymagic, представленный в главном столбцом формате. Код MATLAB для функции mymagic следует.

function out = mymagic(in)
out = magic(in);

Для этого примера, чтобы запуститься, экземпляр MATLAB Production Server, содержащий развернутую функцию MATLAB должен запускаться mymagic. Для получения дополнительной информации о том, как создать развертываемый архив, смотрите, Создают Развертываемый Архив для MATLAB Production Server. Для получения дополнительной информации о подготовке сервера смотрите, Создают Сервер.

Реализация JavaScript

С реализацией JavaScript УСПОКОИТЕЛЬНОГО API вы включаете скрипт в тегах <script> </script> страницы HTML. Когда эта страница HTML открыта в веб-браузере, значения функции mymagic возвращены. Обратите внимание на то, что серверу нужно было позволить CORS для кода JavaScript работать. Для получения дополнительной информации смотрите cors-allowed-origins.

Код:

restApiSyncMagicJavaScript.html

Реализация Python

Этот пример использует Python 2.x. Если вы используете Python 3.x, необходимо изменить некоторые фрагменты кода.

Код:

restApiSyncMagicPython.py

Чтобы изучить, как развернуть функцию MATLAB на MATLAB Production Server и вызвать его с помощью УСПОКОИТЕЛЬНОГО API и JSON, смотрите Пример: веб-Инструмент Оценки Связи Используя JavaScript.

Асинхронное выполнение

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

УСПОКОИТЕЛЬНЫЕ вызовы API асинхронного режима

Вызвать	Цель
`POST Asynchronous Request`	Выполните асинхронный запрос к серверу
`GET Representation of Asynchronous Request`	Просмотрите, как представлен асинхронный запрос, выполненный к серверу
`GET Collection of Requests`	Просмотрите набор запросов
`GET State Information`	Получите информацию состояния запроса
`GET Result of Request`	Получите результаты запроса
`POST Cancel Request`	Отмените запрос
`DELETE Request`	Удалите запрос

Следующая диаграмма иллюстрирует, как УСПОКОИТЕЛЬНЫЙ API работает в асинхронном режиме. Диаграмма не покрывает все УСПОКОИТЕЛЬНЫЕ вызовы API. Для полного списка вызовов см. предыдущую таблицу.

Пример: асинхронное выполнение магического квадрата Используя УСПОКОИТЕЛЬНЫЙ API и JSON

Этот пример показывает, как использовать УСПОКОИТЕЛЬНЫЙ API и JSON для асинхронного выполнения с помощью JavaScript. Когда вы выполняете этот пример, сервер возвращает список 100 разделенных от запятой значений. Этими значениями является вывод развернутой функции MATLAB mymagic, представленный в главном столбцом формате. Код MATLAB для функции mymagic следует.

function out = mymagic(in)
out = magic(in);

Код:

restApiAsyncMagicJavaScript.html

<!DOCTYPE html>
<html>

    <head>
        <title>Magic Square</title>
        <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.11.0/jquery.min.js"></script>
        <script>
            // MPS RESTful API (Asynchronous): Specify URL
            var hostname = "http://localhost:9910";
            var mode = "async";
            var clientID = "client100";
            var ctfName = "mymagic";
            var matlabFuncName = "mymagic"
            var url = hostname + "/" + ctfName + "/" + matlabFuncName + "?mode=" + mode + "&client=" + clientID;
            // Specify arguments
            var params = {
                "nargout": 1,
                "rhs": [100],
                "outputFormat": {"mode": "small"}
            };
            $.ajax(url, {
                data: JSON.stringify(params),
                //MPS RESTful API (Asynchronous): Specify Content-Type to application/json and Specify HTTP POST method
                contentType: 'application/json',
                method: 'POST',
                dataType: 'json',
                success: function(response) {
                    // Print Request URI to webpage
                    $("#requestURI").html('<strong>Request URI: </strong>' + hostname + response.self);
                    pollUsingUp(response);
                }
            });
            // Polling Server using UP
            function pollUsingUp(request) {
                setTimeout(function() {
                    var newSeq = parseInt(request.lastModifiedSeq) + 1;
                    var queryURI = hostname + request.up + "?since=" + newSeq + "&ids=" + request.id;
                    $.ajax({
                        url: queryURI,
                        method: 'GET',
                        dataType: 'json',
                        success: function(response) {
                            //Poll again if no data about the request was received.
                            if (response.data.length == 0) {
                                pollUsingUp(request);
                                return;
                            }

                            var requestResource = response.data[0];
                            // Print "state" of request
                            $("#state").html('<strong>State: </strong>' + requestResource.state);


                            if (requestResource.state != "READY" && requestResource.state != "ERROR") {
                                //Keep polling if the request is not done yet.
                                pollUsingUp(requestResource);
                            } else {
                                var requestURI = hostname + requestResource.self;
                                var responseURI = hostname + requestResource.self + "/result";
                                // Get result.
                                $.ajax({
                                    url: responseURI,
                                    // MPS RESTful API (Asynchronous): Specify HTTP GET method
                                    method: 'GET',
                                    dataType: 'json',
                                    success: function(response) {
                                        if (response.hasOwnProperty("lhs")) {
                                            $("#demo").html('<p>' +
                                                response.lhs[0] + '</p>');
                                            //Uncomment the next line if using JSON large representation
                                            //response.lhs[0].mwdata + '</p>');

                                        } else if (response.hasOwnProperty("error")) {
                                            alert("Error: " + response.error.message);
                                        }
                                        // MPS RESTful API (Asynchronous): Specify HTTP DELETE method
                                        $.ajax({
                                            url: requestURI,
                                            method: 'DELETE'
                                        });
                                    }
                                });
                            }
                        }
                    });
                }, 200);
            }
        </script>
    </head>

    <body>
        <p><strong>MPS RESTful API and JSON EXAMPLE</strong></p>
        <p> >> mymagic(5)</p>
        <p id="requestURI"></p>
        <p id="state"></p>
        <p id="demo"></p>
        <p> # output from server returned in column-major format </p>
    </body>

</html>

Сервис открытия

Можно использовать сервис открытия узнать о функциях MATLAB, развернутых на сервере. Сервис открытия возвращает информацию о развернутых функциях MATLAB как объект JSON. Объект является многоуровневой вложенной структурой, и на высоком уровне отображает версию схемы открытия и список развернутых архивов. Информация о развернутых функциях MATLAB и их функциональных подписях содержится в каждом из перечисленных архивов. Для получения дополнительной информации см. Объект Ответа JSON.

Чтобы использовать сервис открытия, необходимо включить сервис открытия на сервер. Можно сделать это путем некомментария опции --enable-discovery в файле main_config сервера.

Чтобы получить полезную информацию при использовании сервиса открытия, необходимо включать файл JSON, содержащий функциональные подписи развернутых функций MATLAB при создании развертываемого архива. Для получения дополнительной информации смотрите, Создают Развертываемый Архив для MATLAB Production Server. Для получения информации о создании файла JSON, содержащего функциональные подписи, смотрите Подписи функции MATLAB в JSON.

Можно вызвать сервис открытия с помощью метода GET HTTP.

УСПОКОИТЕЛЬНЫЕ вызовы API сервиса открытия

Вызвать	Цель
`GET Discovery Information`	Узнайте функции MATLAB, развернутые на сервере

Ответ с сервера является объектом JSON.

Объект ответа JSON

Object {;}

Имя	Описание
`discoverySchemaVersion`	Номер версии для схемы открытия Пример value: `1.0.0`
► `archives`	Список развернутых архивов. Смотрите Архивы

Архивы

archives

Имя	Описание
`archiveSchemaVersion`	Номер версии архивной схемы. Значение в качестве примера: `1.1.0`
`archiveUuid`	Уникальный идентификатор
`name`	Имя архива ctf
`matlabRuntimeVersion`	Версия MATLAB Runtime. Значение в качестве примера: `9.5.0`
`typedefs`	Если ваши развернутые функции MATLAB требуют массивов ячеек или структур как входные параметры, они должны быть заданы как `typedefs`. Для получения дополнительной информации смотрите Определения типов
`► functions`	Функциональный объект для каждой развернутой функции. Для получения дополнительной информации смотрите Функции

Определения типов

typedefs

Функции

functions

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