REST API. Общие сведения
- получить данные (GET-запросы);
- создать новые элементы данных (POST-запросы);
- изменить данные (PUT-запросы);
- удалить данные (DELETE-запросы);
- обновить данные (PATCH-запросы).
Для передачи команд через REST API может использоваться утилита curl
.
Curl
- кроссплатформенная служебная программа командной строки, позволяющая взаимодействовать с множеством различных серверов по множеству различных протоколов с синтаксисом URL.
При работе с внешней утилитой curl
возникает ряд особенностей:
- для отправки запроса GET использовать опцию
-X 'GET'
; - для отправки запроса DELETE использовать опцию
-X 'DELETE'
; - для отправки запроса PUT использовать опцию
-X 'PUT'
; - для отправки запроса POST использовать опцию
-X 'POST'
; - для отправки запроса PATCH использовать опцию
-X 'PATCH'
.
Возвращаемые форматы задаются заголовком accept
, например:
curl ... -H "accept:application/json"
BASH
Пример POST-запроса:
curl -X 'POST' \
'http://disp.termidesk.local/api/webui/v1/servicespools' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Auth-Token: 7bjqtodywjd69dkpdta9ncqprifkr3pu' \
-d '{
"name": "string",
"comments": "string",
"service_id": "string",
"osmanager_id": "string",
"image_id": "string",
"help_url": "string",
"servicesPoolGroup_id": "string",
"cache_l1_srvs": 2147483647,
"cache_l2_srvs": 2147483647,
"max_srvs": 2147483647,
"debug_mode": true,
"backup": true,
"fallbackAccess": "string"
}'
BASH
Результирующий формат указывается в ответном заголовке content-type
.