{"id":14268,"url":"\/distributions\/14268\/click?bit=1&hash=1e3309842e8b07895e75261917827295839cd5d4d57d48f0ca524f3f535a7946","title":"\u0420\u0430\u0437\u0440\u0435\u0448\u0430\u0442\u044c \u0441\u043e\u0442\u0440\u0443\u0434\u043d\u0438\u043a\u0430\u043c \u0438\u0433\u0440\u0430\u0442\u044c \u043d\u0430 \u0440\u0430\u0431\u043e\u0447\u0435\u043c \u043c\u0435\u0441\u0442\u0435 \u044d\u0444\u0444\u0435\u043a\u0442\u0438\u0432\u043d\u043e?","buttonText":"\u0423\u0437\u043d\u0430\u0442\u044c","imageUuid":"f71e1caf-7964-5525-98be-104bb436cb54"}
Василий Волгин

Про API запросы и статусы. Для начинающих тестировщиков. 2023 IT

API-запросы представляют собой отправку запросов на сервер по определенным эндпоинтам с использованием различных методов HTTP, таких как GET, POST, PUT, DELETE и других. Тестирование API является одной из важных тем для проверки качества работы ПО.

Далее вы узнаете про основы:

  • Про API запросы
  • HTTP статусы

API запросы.

API запросы могут быть разных типов в зависимости от выполняемого действия и используемого метода. Вот некоторые из наиболее распространенных типов API запросов:

1.) GET: Запрос на получение данных из сервера. Он используется для извлечения информации из ресурса без его изменения.

Получение списка всех пользователей:

GET /api/users

Получение информации о конкретном пользователе:

GET /api/users/{id}

2.) POST: Запрос на создание нового ресурса на сервере. Он используется для отправки данных на сервер для создания нового объекта или выполнения какого-либо действия.

Создание нового пользователя:

POST /api/users Content-Type: application/json { "name": "John Doe", "email": "[email protected]", "age": 25 }

Создание нового заказа:

POST /api/orders Content-Type: application/json { "product": "iPhone", "quantity": 2, "customer_id": "12345" }

3.) PUT: Запрос на обновление существующего ресурса на сервере. Он используется для изменения информации или состояния существующего ресурса.

Обновление информации о пользователе:

PUT /api/users/{id} Content-Type: application/json { "name": "Jane Smith", "email": "[email protected]", "age": 30 }

Обновление информации о заказе:

PUT /api/orders/{id} Content-Type: application/json { "product": "Samsung Galaxy", "quantity": 3, "customer_id": "54321" }

4.) DELETE: Запрос на удаление существующего ресурса на сервере. Он используется для удаления ресурса по его идентификатору или другому уникальному идентификатору.

Удаление пользователя:

DELETE /api/users/{id}

Удаление заказа:

DELETE /api/orders/{id}

5.) PATCH: Запрос на частичное обновление существующего ресурса на сервере. Он используется для изменения только некоторых полей или атрибутов ресурса, не затрагивая остальные.

Частичное обновление информации о заказе:

PATCH /api/orders/{id} Content-Type: application/json { "quantity": 5 }

Частичное обновление информации о пользователе:

PATCH /api/users/{id} Content-Type: application/json { "email": "[email protected]" }

HTTP статусы.

HTTP статусы являются важной частью коммуникации между клиентом и сервером в API. Они предоставляют информацию о результате выполнения запроса и помогают клиентскому приложению принять соответствующие действия. Вот некоторые распространенные примеры использования HTTP статусов в API:

  • 200 OK: Запрос успешно выполнен. В ответе содержится запрашиваемая информация.
  • 201 Created: Запрос успешно выполнен, и в результате был создан новый ресурс.
  • 204 No Content: Запрос успешно выполнен, но в ответе нет содержимого.
  • 400 Bad Request: Запрос содержит некорректные данные или не может быть обработан сервером.
  • 401 Unauthorized: Требуется аутентификация для доступа к ресурсу.
  • 403 Forbidden: У клиента нет разрешения на доступ к ресурсу.
  • 404 Not Found: Запрашиваемый ресурс не найден на сервере.
  • 500 Internal Server Error: Произошла внутренняя ошибка сервера при обработке запроса.

Примеры использования HTTP статусов в API:

1.) Запрос информации о пользователе:

URL: https://api.example.com/users/123Метод: GET

Ответ: Код статуса: 200 OK

Тело ответа: {"id": 123, "name": "John Doe", "email": "[email protected]"}

2.) Создание нового пользователя:

URL: https://api.example.com/users

Метод: POST

Тело запроса: {"name": "Alice", "email": "[email protected]"}

Ответ: Код статуса: 201 Created

Тело ответа: {"id": 456, "name": "Alice", "email": "[email protected]"}

3.) Попытка доступа к защищенному ресурсу без аутентификации:

URL: https://api.example.com/protected-resource

Метод: GET

Ответ: Код статуса: 401 Unauthorized

Тело ответа: {"message": "Authentication required"}

4.) Запрос несуществующего ресурса:

URL: https://api.example.com/nonexistent-resource.

Метод: GET

Ответ: Код статуса: 404 Not Found

Тело ответа: {"message": "Resource not found"}

Также рекомендую к изучению статью тоже про API:

Василий Волгин
Про API для начинающих тестировщиков. Разница между REST и SOAP. 2022

Что такое API? Коротко расскажу основное для начинающих, что необходимо знать или хотя бы просто услышать разок, но без зубрежки.

Подпишись:

Записки Тестировщика / Василий Волгин
Канал про тестирование и мир IT. Здесь автор делится знаниями и помогает войти в IT. Немного о…
t.me
Василий Волгин - full stack тестировщик
733 показа
5.8K открытий
0
Комментарии
Написать комментарий...
-3 комментариев
Раскрывать всегда