Таблица с основными REST-API методами, их описанием и примерами вызова:
| Метод | Описание | Пример вызова |
|---|---|---|
| GET | Используется для получения данных с сервера. Не изменяет состояние ресурса. | GET /users — получить список пользователей. |
| POST | Используется для создания нового ресурса или отправки данных на сервер. | POST /users — создать нового пользователя (тело запроса: {"name": "John"}). |
| PUT | Используется для полного обновления ресурса. Заменяет весь ресурс. | PUT /users/1 — обновить данные пользователя с ID 1 (тело запроса: {"name": "Jane"}). |
| PATCH | Используется для частичного обновления ресурса. | PATCH /users/1 — обновить имя пользователя с ID 1 (тело запроса: {"name": "Jane"}). |
| DELETE | Используется для удаления ресурса. | DELETE /users/1 — удалить пользователя с ID 1. |
| HEAD | Используется для получения метаданных ресурса (заголовков) без тела ответа. | HEAD /users — получить заголовки ответа для списка пользователей. |
| OPTIONS | Используется для получения информации о доступных методах для ресурса. | OPTIONS /users — получить список методов, поддерживаемых для /users. |
Примеры вызовов с использованием cURL
GET
curl -X GET https://api.example.com/users
Ответ
[
{
"id": 1,
"name": "John",
"email": "john@example.com"
},
{
"id": 2,
"name": "Jane",
"email": "jane@example.com"
}
]
POST
curl -X POST https://api.example.com/users \
-H "Content-Type: application/json" \
-d '{"name": "John", "email": "john@example.com"}'
Ответ:
{
"id": 3,
"name": "John",
"email": "john@example.com"
}
PUT
curl -X PUT https://api.example.com/users/1 \
-H "Content-Type: application/json" \
-d '{"name": "Jane", "email": "jane@example.com"}'
Ответ:
{
"id": 1,
"name": "Jane",
"email": "jane@example.com"
}
PATCH
curl -X PATCH https://api.example.com/users/1 \
-H "Content-Type: application/json" \
-d '{"name": "Jane"}'
Ответ:
{
"id": 1,
"name": "Jane",
"email": "john@example.com"
}
DELETE
curl -X DELETE https://api.example.com/users/1
Ответ:
{
"message": "User deleted successfully"
}
HEAD
curl -X HEAD https://api.example.com/users
Ответ:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 123
OPTIONS
curl -X OPTIONS https://api.example.com/users
Ответ:
{
"methods": ["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS"]
}
Итог
REST-API методы позволяют выполнять CRUD-операции (Create, Read, Update, Delete) и управлять ресурсами на сервере. Каждый метод имеет свою специфику и применяется в зависимости от задачи.
#RESTAPI #HTTPMethods #GET #POST #PUT #PATCH #DELETE #WebDevelopment #APIDesign #TechTips
Нет Ответов