...
Code Block | ||||
---|---|---|---|---|
| ||||
http.port=8081 https.port=8444 |
Междоменные запросы
Междоменные запросы управляются следующими настройками в файле flashphoner.properties
Code Block | ||||
---|---|---|---|---|
| ||||
rest_access_control_allow_origin=*
rest_access_control_allow_headers=content-type,x-requested-with
rest_access_control_allow_methods=POST |
По умолчанию разрешены междоменные запросы с любого адреса, чтобы обеспечить перенаправление портов.
Авторизация
По умолчанию, REST API запросы обрабатываются без авторизации. При необходимости, может быть включена Basic авторизация при помощи следующего параметра в файле flashphoner.properties
...
Пользователи REST API при включении авторизации управляются из командной строки ядра WCS.
Междоменные запросы
Междоменные запросы управляются следующими настройками в файле Для междоменных запросов необходимо добавить заголовки при помощи следующей настройки в файле flashphoner.properties:
Code Block | language | bash|
---|---|---|
| ||
rest_access_control_allow_origin=*
rest_access_control_allow_headers=content-type,x-requested-with
rest_access_control_allow_methods=POST |
...
headers=Access-Control-Allow-Origin: <origin>;Access-Control-Allow-Credentials: true;Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS;Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Authorization |
Здесь <origin>- источник запроса, например http://test.flashphoner.com.
Тестирование
Для тестирования можно использовать REST-клиент. Например Advanced REST Console для браузера Google Chrome.
На скриншотах скриншоте приведен пример обращения из Advanced REST Console к серверу с получением списка текущих потоков REST методом /stream/find_all
OpenAPI спецификация
В сборке 5.2.1343 добавлен интерфейс для отображения и тестирования REST API в соответствии с OpenAPI 3 спецификацией. Файл OpenAPI спецификации может быть загружен по адресу https://demo.flashphoner.com:8444/rest-api/openapi_spec в формате YAML, интерфейс доступен по адресу https://demo.flashphoner.com:8444/rest-api-spec/, где demo.flashphoner.com
- адрес WCS сервера
Каждый запрос можно развернуть и протестировать при помощи Swagger UI
Обязательные поля отмечены символом *
на вкладке Schema